2441 lines
175 KiB
HTML
2441 lines
175 KiB
HTML
|
|
|||
|
|
<!DOCTYPE html>
|
|||
|
|
|
|||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8" />
|
|||
|
|
<title>curses — Terminal handling for character-cell displays — Python 3.7.4 documentation</title>
|
|||
|
|
<link rel="stylesheet" href="../_static/pydoctheme.css" type="text/css" />
|
|||
|
|
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
|||
|
|
|
|||
|
|
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></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/language_data.js"></script>
|
|||
|
|
|
|||
|
|
<script type="text/javascript" src="../_static/sidebar.js"></script>
|
|||
|
|
|
|||
|
|
<link rel="search" type="application/opensearchdescription+xml"
|
|||
|
|
title="Search within Python 3.7.4 documentation"
|
|||
|
|
href="../_static/opensearch.xml"/>
|
|||
|
|
<link rel="author" title="About these documents" href="../about.html" />
|
|||
|
|
<link rel="index" title="Index" href="../genindex.html" />
|
|||
|
|
<link rel="search" title="Search" href="../search.html" />
|
|||
|
|
<link rel="copyright" title="Copyright" href="../copyright.html" />
|
|||
|
|
<link rel="next" title="curses.ascii — Utilities for ASCII characters" href="curses.ascii.html" />
|
|||
|
|
<link rel="prev" title="getpass — Portable password input" href="getpass.html" />
|
|||
|
|
<link rel="shortcut icon" type="image/png" href="../_static/py.png" />
|
|||
|
|
<link rel="canonical" href="https://docs.python.org/3/library/curses.html" />
|
|||
|
|
|
|||
|
|
<script type="text/javascript" src="../_static/copybutton.js"></script>
|
|||
|
|
<script type="text/javascript" src="../_static/switchers.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<style>
|
|||
|
|
@media only screen {
|
|||
|
|
table.full-width-table {
|
|||
|
|
width: 100%;
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
</style>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</head><body>
|
|||
|
|
|
|||
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|||
|
|
<h3>Navigation</h3>
|
|||
|
|
<ul>
|
|||
|
|
<li class="right" style="margin-right: 10px">
|
|||
|
|
<a href="../genindex.html" title="General Index"
|
|||
|
|
accesskey="I">index</a></li>
|
|||
|
|
<li class="right" >
|
|||
|
|
<a href="../py-modindex.html" title="Python Module Index"
|
|||
|
|
>modules</a> |</li>
|
|||
|
|
<li class="right" >
|
|||
|
|
<a href="curses.ascii.html" title="curses.ascii — Utilities for ASCII characters"
|
|||
|
|
accesskey="N">next</a> |</li>
|
|||
|
|
<li class="right" >
|
|||
|
|
<a href="getpass.html" title="getpass — Portable password input"
|
|||
|
|
accesskey="P">previous</a> |</li>
|
|||
|
|
<li><img src="../_static/py.png" alt=""
|
|||
|
|
style="vertical-align: middle; margin-top: -1px"/></li>
|
|||
|
|
<li><a href="https://www.python.org/">Python</a> »</li>
|
|||
|
|
<li>
|
|||
|
|
<span class="language_switcher_placeholder">en</span>
|
|||
|
|
<span class="version_switcher_placeholder">3.7.4</span>
|
|||
|
|
<a href="../index.html">Documentation </a> »
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li>
|
|||
|
|
<li class="nav-item nav-item-2"><a href="allos.html" accesskey="U">Generic Operating System Services</a> »</li>
|
|||
|
|
<li class="right">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="inline-search" style="display: none" role="search">
|
|||
|
|
<form class="inline-search" action="../search.html" method="get">
|
|||
|
|
<input placeholder="Quick search" type="text" name="q" />
|
|||
|
|
<input type="submit" value="Go" />
|
|||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|||
|
|
<input type="hidden" name="area" value="default" />
|
|||
|
|
</form>
|
|||
|
|
</div>
|
|||
|
|
<script type="text/javascript">$('.inline-search').show(0);</script>
|
|||
|
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="document">
|
|||
|
|
<div class="documentwrapper">
|
|||
|
|
<div class="bodywrapper">
|
|||
|
|
<div class="body" role="main">
|
|||
|
|
|
|||
|
|
<div class="section" id="module-curses">
|
|||
|
|
<span id="curses-terminal-handling-for-character-cell-displays"></span><h1><a class="reference internal" href="#module-curses" title="curses: An interface to the curses library, providing portable terminal handling. (Unix)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">curses</span></code></a> — Terminal handling for character-cell displays<a class="headerlink" href="#module-curses" title="Permalink to this headline">¶</a></h1>
|
|||
|
|
<hr class="docutils" />
|
|||
|
|
<p>The <a class="reference internal" href="#module-curses" title="curses: An interface to the curses library, providing portable terminal handling. (Unix)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">curses</span></code></a> module provides an interface to the curses library, the
|
|||
|
|
de-facto standard for portable advanced terminal handling.</p>
|
|||
|
|
<p>While curses is most widely used in the Unix environment, versions are available
|
|||
|
|
for Windows, DOS, and possibly other systems as well. This extension module is
|
|||
|
|
designed to match the API of ncurses, an open-source curses library hosted on
|
|||
|
|
Linux and the BSD variants of Unix.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>Whenever the documentation mentions a <em>character</em> it can be specified
|
|||
|
|
as an integer, a one-character Unicode string or a one-byte byte string.</p>
|
|||
|
|
<p>Whenever the documentation mentions a <em>character string</em> it can be specified
|
|||
|
|
as a Unicode string or a byte string.</p>
|
|||
|
|
</div>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>Since version 5.4, the ncurses library decides how to interpret non-ASCII data
|
|||
|
|
using the <code class="docutils literal notranslate"><span class="pre">nl_langinfo</span></code> function. That means that you have to call
|
|||
|
|
<a class="reference internal" href="locale.html#locale.setlocale" title="locale.setlocale"><code class="xref py py-func docutils literal notranslate"><span class="pre">locale.setlocale()</span></code></a> in the application and encode Unicode strings
|
|||
|
|
using one of the system’s available encodings. This example uses the
|
|||
|
|
system’s default encoding:</p>
|
|||
|
|
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">locale</span>
|
|||
|
|
<span class="n">locale</span><span class="o">.</span><span class="n">setlocale</span><span class="p">(</span><span class="n">locale</span><span class="o">.</span><span class="n">LC_ALL</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span>
|
|||
|
|
<span class="n">code</span> <span class="o">=</span> <span class="n">locale</span><span class="o">.</span><span class="n">getpreferredencoding</span><span class="p">()</span>
|
|||
|
|
</pre></div>
|
|||
|
|
</div>
|
|||
|
|
<p>Then use <em>code</em> as the encoding for <a class="reference internal" href="stdtypes.html#str.encode" title="str.encode"><code class="xref py py-meth docutils literal notranslate"><span class="pre">str.encode()</span></code></a> calls.</p>
|
|||
|
|
</div>
|
|||
|
|
<div class="admonition seealso">
|
|||
|
|
<p class="admonition-title">See also</p>
|
|||
|
|
<dl class="simple">
|
|||
|
|
<dt>Module <a class="reference internal" href="curses.ascii.html#module-curses.ascii" title="curses.ascii: Constants and set-membership functions for ASCII characters."><code class="xref py py-mod docutils literal notranslate"><span class="pre">curses.ascii</span></code></a></dt><dd><p>Utilities for working with ASCII characters, regardless of your locale settings.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt>Module <a class="reference internal" href="curses.panel.html#module-curses.panel" title="curses.panel: A panel stack extension that adds depth to curses windows."><code class="xref py py-mod docutils literal notranslate"><span class="pre">curses.panel</span></code></a></dt><dd><p>A panel stack extension that adds depth to curses windows.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt>Module <a class="reference internal" href="#module-curses.textpad" title="curses.textpad: Emacs-like input editing in a curses window."><code class="xref py py-mod docutils literal notranslate"><span class="pre">curses.textpad</span></code></a></dt><dd><p>Editable text widget for curses supporting <strong class="program">Emacs</strong>-like bindings.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt><a class="reference internal" href="../howto/curses.html#curses-howto"><span class="std std-ref">Curses Programming with Python</span></a></dt><dd><p>Tutorial material on using curses with Python, by Andrew Kuchling and Eric
|
|||
|
|
Raymond.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
<p>The <a class="reference external" href="https://github.com/python/cpython/tree/3.7/Tools/demo/">Tools/demo/</a> directory in the Python source distribution contains
|
|||
|
|
some example programs using the curses bindings provided by this module.</p>
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="functions">
|
|||
|
|
<span id="curses-functions"></span><h2>Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The module <a class="reference internal" href="#module-curses" title="curses: An interface to the curses library, providing portable terminal handling. (Unix)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">curses</span></code></a> defines the following exception:</p>
|
|||
|
|
<dl class="exception">
|
|||
|
|
<dt id="curses.error">
|
|||
|
|
<em class="property">exception </em><code class="descclassname">curses.</code><code class="descname">error</code><a class="headerlink" href="#curses.error" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Exception raised when a curses library function returns an error.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>Whenever <em>x</em> or <em>y</em> arguments to a function or a method are optional, they
|
|||
|
|
default to the current cursor location. Whenever <em>attr</em> is optional, it defaults
|
|||
|
|
to <code class="xref py py-const docutils literal notranslate"><span class="pre">A_NORMAL</span></code>.</p>
|
|||
|
|
</div>
|
|||
|
|
<p>The module <a class="reference internal" href="#module-curses" title="curses: An interface to the curses library, providing portable terminal handling. (Unix)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">curses</span></code></a> defines the following functions:</p>
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.baudrate">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">baudrate</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.baudrate" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return the output speed of the terminal in bits per second. On software
|
|||
|
|
terminal emulators it will have a fixed high value. Included for historical
|
|||
|
|
reasons; in former times, it was used to write output loops for time delays and
|
|||
|
|
occasionally to change interfaces depending on the line speed.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.beep">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">beep</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.beep" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Emit a short attention sound.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.can_change_color">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">can_change_color</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.can_change_color" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> or <code class="docutils literal notranslate"><span class="pre">False</span></code>, depending on whether the programmer can change the colors
|
|||
|
|
displayed by the terminal.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.cbreak">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">cbreak</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.cbreak" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Enter cbreak mode. In cbreak mode (sometimes called “rare” mode) normal tty
|
|||
|
|
line buffering is turned off and characters are available to be read one by one.
|
|||
|
|
However, unlike raw mode, special characters (interrupt, quit, suspend, and flow
|
|||
|
|
control) retain their effects on the tty driver and calling program. Calling
|
|||
|
|
first <a class="reference internal" href="#curses.raw" title="curses.raw"><code class="xref py py-func docutils literal notranslate"><span class="pre">raw()</span></code></a> then <a class="reference internal" href="#curses.cbreak" title="curses.cbreak"><code class="xref py py-func docutils literal notranslate"><span class="pre">cbreak()</span></code></a> leaves the terminal in cbreak mode.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.color_content">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">color_content</code><span class="sig-paren">(</span><em>color_number</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.color_content" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return the intensity of the red, green, and blue (RGB) components in the color
|
|||
|
|
<em>color_number</em>, which must be between <code class="docutils literal notranslate"><span class="pre">0</span></code> and <code class="xref py py-const docutils literal notranslate"><span class="pre">COLORS</span></code>. Return a 3-tuple,
|
|||
|
|
containing the R,G,B values for the given color, which will be between
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">0</span></code> (no component) and <code class="docutils literal notranslate"><span class="pre">1000</span></code> (maximum amount of component).</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.color_pair">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">color_pair</code><span class="sig-paren">(</span><em>color_number</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.color_pair" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return the attribute value for displaying text in the specified color. This
|
|||
|
|
attribute value can be combined with <code class="xref py py-const docutils literal notranslate"><span class="pre">A_STANDOUT</span></code>, <code class="xref py py-const docutils literal notranslate"><span class="pre">A_REVERSE</span></code>,
|
|||
|
|
and the other <code class="xref py py-const docutils literal notranslate"><span class="pre">A_*</span></code> attributes. <a class="reference internal" href="#curses.pair_number" title="curses.pair_number"><code class="xref py py-func docutils literal notranslate"><span class="pre">pair_number()</span></code></a> is the counterpart
|
|||
|
|
to this function.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.curs_set">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">curs_set</code><span class="sig-paren">(</span><em>visibility</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.curs_set" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Set the cursor state. <em>visibility</em> can be set to <code class="docutils literal notranslate"><span class="pre">0</span></code>, <code class="docutils literal notranslate"><span class="pre">1</span></code>, or <code class="docutils literal notranslate"><span class="pre">2</span></code>, for invisible,
|
|||
|
|
normal, or very visible. If the terminal supports the visibility requested, return the
|
|||
|
|
previous cursor state; otherwise raise an exception. On many
|
|||
|
|
terminals, the “visible” mode is an underline cursor and the “very visible” mode
|
|||
|
|
is a block cursor.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.def_prog_mode">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">def_prog_mode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.def_prog_mode" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Save the current terminal mode as the “program” mode, the mode when the running
|
|||
|
|
program is using curses. (Its counterpart is the “shell” mode, for when the
|
|||
|
|
program is not in curses.) Subsequent calls to <a class="reference internal" href="#curses.reset_prog_mode" title="curses.reset_prog_mode"><code class="xref py py-func docutils literal notranslate"><span class="pre">reset_prog_mode()</span></code></a> will
|
|||
|
|
restore this mode.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.def_shell_mode">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">def_shell_mode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.def_shell_mode" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Save the current terminal mode as the “shell” mode, the mode when the running
|
|||
|
|
program is not using curses. (Its counterpart is the “program” mode, when the
|
|||
|
|
program is using curses capabilities.) Subsequent calls to
|
|||
|
|
<a class="reference internal" href="#curses.reset_shell_mode" title="curses.reset_shell_mode"><code class="xref py py-func docutils literal notranslate"><span class="pre">reset_shell_mode()</span></code></a> will restore this mode.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.delay_output">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">delay_output</code><span class="sig-paren">(</span><em>ms</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.delay_output" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Insert an <em>ms</em> millisecond pause in output.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.doupdate">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">doupdate</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.doupdate" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Update the physical screen. The curses library keeps two data structures, one
|
|||
|
|
representing the current physical screen contents and a virtual screen
|
|||
|
|
representing the desired next state. The <a class="reference internal" href="#curses.doupdate" title="curses.doupdate"><code class="xref py py-func docutils literal notranslate"><span class="pre">doupdate()</span></code></a> ground updates the
|
|||
|
|
physical screen to match the virtual screen.</p>
|
|||
|
|
<p>The virtual screen may be updated by a <a class="reference internal" href="#curses.window.noutrefresh" title="curses.window.noutrefresh"><code class="xref py py-meth docutils literal notranslate"><span class="pre">noutrefresh()</span></code></a> call after write
|
|||
|
|
operations such as <a class="reference internal" href="#curses.window.addstr" title="curses.window.addstr"><code class="xref py py-meth docutils literal notranslate"><span class="pre">addstr()</span></code></a> have been performed on a window. The normal
|
|||
|
|
<a class="reference internal" href="#curses.window.refresh" title="curses.window.refresh"><code class="xref py py-meth docutils literal notranslate"><span class="pre">refresh()</span></code></a> call is simply <code class="xref py py-meth docutils literal notranslate"><span class="pre">noutrefresh()</span></code> followed by <code class="xref py py-func docutils literal notranslate"><span class="pre">doupdate()</span></code>;
|
|||
|
|
if you have to update multiple windows, you can speed performance and perhaps
|
|||
|
|
reduce screen flicker by issuing <code class="xref py py-meth docutils literal notranslate"><span class="pre">noutrefresh()</span></code> calls on all windows,
|
|||
|
|
followed by a single <code class="xref py py-func docutils literal notranslate"><span class="pre">doupdate()</span></code>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.echo">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">echo</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.echo" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Enter echo mode. In echo mode, each character input is echoed to the screen as
|
|||
|
|
it is entered.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.endwin">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">endwin</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.endwin" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>De-initialize the library, and return terminal to normal status.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.erasechar">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">erasechar</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.erasechar" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return the user’s current erase character as a one-byte bytes object. Under Unix operating systems this
|
|||
|
|
is a property of the controlling tty of the curses program, and is not set by
|
|||
|
|
the curses library itself.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.filter">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">filter</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.filter" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The <a class="reference internal" href="#curses.filter" title="curses.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">filter()</span></code></a> routine, if used, must be called before <a class="reference internal" href="#curses.initscr" title="curses.initscr"><code class="xref py py-func docutils literal notranslate"><span class="pre">initscr()</span></code></a> is
|
|||
|
|
called. The effect is that, during those calls, <span class="target" id="index-0"></span><code class="xref std std-envvar docutils literal notranslate"><span class="pre">LINES</span></code> is set to <code class="docutils literal notranslate"><span class="pre">1</span></code>; the
|
|||
|
|
capabilities <code class="docutils literal notranslate"><span class="pre">clear</span></code>, <code class="docutils literal notranslate"><span class="pre">cup</span></code>, <code class="docutils literal notranslate"><span class="pre">cud</span></code>, <code class="docutils literal notranslate"><span class="pre">cud1</span></code>, <code class="docutils literal notranslate"><span class="pre">cuu1</span></code>, <code class="docutils literal notranslate"><span class="pre">cuu</span></code>, <code class="docutils literal notranslate"><span class="pre">vpa</span></code> are disabled; and the <code class="docutils literal notranslate"><span class="pre">home</span></code>
|
|||
|
|
string is set to the value of <code class="docutils literal notranslate"><span class="pre">cr</span></code>. The effect is that the cursor is confined to
|
|||
|
|
the current line, and so are screen updates. This may be used for enabling
|
|||
|
|
character-at-a-time line editing without touching the rest of the screen.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.flash">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">flash</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.flash" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Flash the screen. That is, change it to reverse-video and then change it back
|
|||
|
|
in a short interval. Some people prefer such as ‘visible bell’ to the audible
|
|||
|
|
attention signal produced by <a class="reference internal" href="#curses.beep" title="curses.beep"><code class="xref py py-func docutils literal notranslate"><span class="pre">beep()</span></code></a>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.flushinp">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">flushinp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.flushinp" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Flush all input buffers. This throws away any typeahead that has been typed
|
|||
|
|
by the user and has not yet been processed by the program.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.getmouse">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">getmouse</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.getmouse" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>After <a class="reference internal" href="#curses.window.getch" title="curses.window.getch"><code class="xref py py-meth docutils literal notranslate"><span class="pre">getch()</span></code></a> returns <code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_MOUSE</span></code> to signal a mouse event, this
|
|||
|
|
method should be call to retrieve the queued mouse event, represented as a
|
|||
|
|
5-tuple <code class="docutils literal notranslate"><span class="pre">(id,</span> <span class="pre">x,</span> <span class="pre">y,</span> <span class="pre">z,</span> <span class="pre">bstate)</span></code>. <em>id</em> is an ID value used to distinguish
|
|||
|
|
multiple devices, and <em>x</em>, <em>y</em>, <em>z</em> are the event’s coordinates. (<em>z</em> is
|
|||
|
|
currently unused.) <em>bstate</em> is an integer value whose bits will be set to
|
|||
|
|
indicate the type of event, and will be the bitwise OR of one or more of the
|
|||
|
|
following constants, where <em>n</em> is the button number from 1 to 4:
|
|||
|
|
<code class="xref py py-const docutils literal notranslate"><span class="pre">BUTTONn_PRESSED</span></code>, <code class="xref py py-const docutils literal notranslate"><span class="pre">BUTTONn_RELEASED</span></code>, <code class="xref py py-const docutils literal notranslate"><span class="pre">BUTTONn_CLICKED</span></code>,
|
|||
|
|
<code class="xref py py-const docutils literal notranslate"><span class="pre">BUTTONn_DOUBLE_CLICKED</span></code>, <code class="xref py py-const docutils literal notranslate"><span class="pre">BUTTONn_TRIPLE_CLICKED</span></code>,
|
|||
|
|
<code class="xref py py-const docutils literal notranslate"><span class="pre">BUTTON_SHIFT</span></code>, <code class="xref py py-const docutils literal notranslate"><span class="pre">BUTTON_CTRL</span></code>, <code class="xref py py-const docutils literal notranslate"><span class="pre">BUTTON_ALT</span></code>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.getsyx">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">getsyx</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.getsyx" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return the current coordinates of the virtual screen cursor as a tuple
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">(y,</span> <span class="pre">x)</span></code>. If <a class="reference internal" href="#curses.window.leaveok" title="curses.window.leaveok"><code class="xref py py-meth docutils literal notranslate"><span class="pre">leaveok</span></code></a> is currently <code class="docutils literal notranslate"><span class="pre">True</span></code>, then return <code class="docutils literal notranslate"><span class="pre">(-1,</span> <span class="pre">-1)</span></code>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.getwin">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">getwin</code><span class="sig-paren">(</span><em>file</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.getwin" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Read window related data stored in the file by an earlier <code class="xref py py-func docutils literal notranslate"><span class="pre">putwin()</span></code> call.
|
|||
|
|
The routine then creates and initializes a new window using that data, returning
|
|||
|
|
the new window object.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.has_colors">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">has_colors</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.has_colors" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the terminal can display colors; otherwise, return <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.has_ic">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">has_ic</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.has_ic" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the terminal has insert- and delete-character capabilities.
|
|||
|
|
This function is included for historical reasons only, as all modern software
|
|||
|
|
terminal emulators have such capabilities.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.has_il">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">has_il</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.has_il" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the terminal has insert- and delete-line capabilities, or can
|
|||
|
|
simulate them using scrolling regions. This function is included for
|
|||
|
|
historical reasons only, as all modern software terminal emulators have such
|
|||
|
|
capabilities.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.has_key">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">has_key</code><span class="sig-paren">(</span><em>ch</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.has_key" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Take a key value <em>ch</em>, and return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the current terminal type recognizes
|
|||
|
|
a key with that value.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.halfdelay">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">halfdelay</code><span class="sig-paren">(</span><em>tenths</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.halfdelay" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Used for half-delay mode, which is similar to cbreak mode in that characters
|
|||
|
|
typed by the user are immediately available to the program. However, after
|
|||
|
|
blocking for <em>tenths</em> tenths of seconds, raise an exception if nothing has
|
|||
|
|
been typed. The value of <em>tenths</em> must be a number between <code class="docutils literal notranslate"><span class="pre">1</span></code> and <code class="docutils literal notranslate"><span class="pre">255</span></code>. Use
|
|||
|
|
<a class="reference internal" href="#curses.nocbreak" title="curses.nocbreak"><code class="xref py py-func docutils literal notranslate"><span class="pre">nocbreak()</span></code></a> to leave half-delay mode.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.init_color">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">init_color</code><span class="sig-paren">(</span><em>color_number</em>, <em>r</em>, <em>g</em>, <em>b</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.init_color" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Change the definition of a color, taking the number of the color to be changed
|
|||
|
|
followed by three RGB values (for the amounts of red, green, and blue
|
|||
|
|
components). The value of <em>color_number</em> must be between <code class="docutils literal notranslate"><span class="pre">0</span></code> and
|
|||
|
|
<code class="xref py py-const docutils literal notranslate"><span class="pre">COLORS</span></code>. Each of <em>r</em>, <em>g</em>, <em>b</em>, must be a value between <code class="docutils literal notranslate"><span class="pre">0</span></code> and
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">1000</span></code>. When <a class="reference internal" href="#curses.init_color" title="curses.init_color"><code class="xref py py-func docutils literal notranslate"><span class="pre">init_color()</span></code></a> is used, all occurrences of that color on the
|
|||
|
|
screen immediately change to the new definition. This function is a no-op on
|
|||
|
|
most terminals; it is active only if <a class="reference internal" href="#curses.can_change_color" title="curses.can_change_color"><code class="xref py py-func docutils literal notranslate"><span class="pre">can_change_color()</span></code></a> returns <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.init_pair">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">init_pair</code><span class="sig-paren">(</span><em>pair_number</em>, <em>fg</em>, <em>bg</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.init_pair" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Change the definition of a color-pair. It takes three arguments: the number of
|
|||
|
|
the color-pair to be changed, the foreground color number, and the background
|
|||
|
|
color number. The value of <em>pair_number</em> must be between <code class="docutils literal notranslate"><span class="pre">1</span></code> and
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">COLOR_PAIRS</span> <span class="pre">-</span> <span class="pre">1</span></code> (the <code class="docutils literal notranslate"><span class="pre">0</span></code> color pair is wired to white on black and cannot
|
|||
|
|
be changed). The value of <em>fg</em> and <em>bg</em> arguments must be between <code class="docutils literal notranslate"><span class="pre">0</span></code> and
|
|||
|
|
<code class="xref py py-const docutils literal notranslate"><span class="pre">COLORS</span></code>. If the color-pair was previously initialized, the screen is
|
|||
|
|
refreshed and all occurrences of that color-pair are changed to the new
|
|||
|
|
definition.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.initscr">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">initscr</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.initscr" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Initialize the library. Return a <a class="reference internal" href="#curses-window-objects"><span class="std std-ref">window</span></a> object
|
|||
|
|
which represents the whole screen.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>If there is an error opening the terminal, the underlying curses library may
|
|||
|
|
cause the interpreter to exit.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.is_term_resized">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">is_term_resized</code><span class="sig-paren">(</span><em>nlines</em>, <em>ncols</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.is_term_resized" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if <a class="reference internal" href="#curses.resize_term" title="curses.resize_term"><code class="xref py py-func docutils literal notranslate"><span class="pre">resize_term()</span></code></a> would modify the window structure,
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">False</span></code> otherwise.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.isendwin">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">isendwin</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.isendwin" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if <a class="reference internal" href="#curses.endwin" title="curses.endwin"><code class="xref py py-func docutils literal notranslate"><span class="pre">endwin()</span></code></a> has been called (that is, the curses library has
|
|||
|
|
been deinitialized).</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.keyname">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">keyname</code><span class="sig-paren">(</span><em>k</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.keyname" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return the name of the key numbered <em>k</em> as a bytes object. The name of a key generating printable
|
|||
|
|
ASCII character is the key’s character. The name of a control-key combination
|
|||
|
|
is a two-byte bytes object consisting of a caret (<code class="docutils literal notranslate"><span class="pre">b'^'</span></code>) followed by the corresponding
|
|||
|
|
printable ASCII character. The name of an alt-key combination (128–255) is a
|
|||
|
|
bytes object consisting of the prefix <code class="docutils literal notranslate"><span class="pre">b'M-'</span></code> followed by the name of the corresponding
|
|||
|
|
ASCII character.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.killchar">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">killchar</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.killchar" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return the user’s current line kill character as a one-byte bytes object. Under Unix operating systems
|
|||
|
|
this is a property of the controlling tty of the curses program, and is not set
|
|||
|
|
by the curses library itself.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.longname">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">longname</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.longname" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return a bytes object containing the terminfo long name field describing the current
|
|||
|
|
terminal. The maximum length of a verbose description is 128 characters. It is
|
|||
|
|
defined only after the call to <a class="reference internal" href="#curses.initscr" title="curses.initscr"><code class="xref py py-func docutils literal notranslate"><span class="pre">initscr()</span></code></a>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.meta">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">meta</code><span class="sig-paren">(</span><em>flag</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.meta" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>If <em>flag</em> is <code class="docutils literal notranslate"><span class="pre">True</span></code>, allow 8-bit characters to be input. If
|
|||
|
|
<em>flag</em> is <code class="docutils literal notranslate"><span class="pre">False</span></code>, allow only 7-bit chars.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.mouseinterval">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">mouseinterval</code><span class="sig-paren">(</span><em>interval</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.mouseinterval" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Set the maximum time in milliseconds that can elapse between press and release
|
|||
|
|
events in order for them to be recognized as a click, and return the previous
|
|||
|
|
interval value. The default value is 200 msec, or one fifth of a second.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.mousemask">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">mousemask</code><span class="sig-paren">(</span><em>mousemask</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.mousemask" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Set the mouse events to be reported, and return a tuple <code class="docutils literal notranslate"><span class="pre">(availmask,</span>
|
|||
|
|
<span class="pre">oldmask)</span></code>. <em>availmask</em> indicates which of the specified mouse events can be
|
|||
|
|
reported; on complete failure it returns <code class="docutils literal notranslate"><span class="pre">0</span></code>. <em>oldmask</em> is the previous value of
|
|||
|
|
the given window’s mouse event mask. If this function is never called, no mouse
|
|||
|
|
events are ever reported.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.napms">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">napms</code><span class="sig-paren">(</span><em>ms</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.napms" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Sleep for <em>ms</em> milliseconds.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.newpad">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">newpad</code><span class="sig-paren">(</span><em>nlines</em>, <em>ncols</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.newpad" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Create and return a pointer to a new pad data structure with the given number
|
|||
|
|
of lines and columns. Return a pad as a window object.</p>
|
|||
|
|
<p>A pad is like a window, except that it is not restricted by the screen size, and
|
|||
|
|
is not necessarily associated with a particular part of the screen. Pads can be
|
|||
|
|
used when a large window is needed, and only a part of the window will be on the
|
|||
|
|
screen at one time. Automatic refreshes of pads (such as from scrolling or
|
|||
|
|
echoing of input) do not occur. The <a class="reference internal" href="#curses.window.refresh" title="curses.window.refresh"><code class="xref py py-meth docutils literal notranslate"><span class="pre">refresh()</span></code></a> and <a class="reference internal" href="#curses.window.noutrefresh" title="curses.window.noutrefresh"><code class="xref py py-meth docutils literal notranslate"><span class="pre">noutrefresh()</span></code></a>
|
|||
|
|
methods of a pad require 6 arguments to specify the part of the pad to be
|
|||
|
|
displayed and the location on the screen to be used for the display. The
|
|||
|
|
arguments are <em>pminrow</em>, <em>pmincol</em>, <em>sminrow</em>, <em>smincol</em>, <em>smaxrow</em>, <em>smaxcol</em>; the <em>p</em>
|
|||
|
|
arguments refer to the upper left corner of the pad region to be displayed and
|
|||
|
|
the <em>s</em> arguments define a clipping box on the screen within which the pad region
|
|||
|
|
is to be displayed.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.newwin">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">newwin</code><span class="sig-paren">(</span><em>nlines</em>, <em>ncols</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.newwin" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dt>
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">newwin</code><span class="sig-paren">(</span><em>nlines</em>, <em>ncols</em>, <em>begin_y</em>, <em>begin_x</em><span class="sig-paren">)</span></dt>
|
|||
|
|
<dd><p>Return a new <a class="reference internal" href="#curses-window-objects"><span class="std std-ref">window</span></a>, whose left-upper corner
|
|||
|
|
is at <code class="docutils literal notranslate"><span class="pre">(begin_y,</span> <span class="pre">begin_x)</span></code>, and whose height/width is <em>nlines</em>/<em>ncols</em>.</p>
|
|||
|
|
<p>By default, the window will extend from the specified position to the lower
|
|||
|
|
right corner of the screen.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.nl">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">nl</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.nl" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Enter newline mode. This mode translates the return key into newline on input,
|
|||
|
|
and translates newline into return and line-feed on output. Newline mode is
|
|||
|
|
initially on.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.nocbreak">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">nocbreak</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.nocbreak" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Leave cbreak mode. Return to normal “cooked” mode with line buffering.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.noecho">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">noecho</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.noecho" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Leave echo mode. Echoing of input characters is turned off.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.nonl">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">nonl</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.nonl" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Leave newline mode. Disable translation of return into newline on input, and
|
|||
|
|
disable low-level translation of newline into newline/return on output (but this
|
|||
|
|
does not change the behavior of <code class="docutils literal notranslate"><span class="pre">addch('\n')</span></code>, which always does the
|
|||
|
|
equivalent of return and line feed on the virtual screen). With translation
|
|||
|
|
off, curses can sometimes speed up vertical motion a little; also, it will be
|
|||
|
|
able to detect the return key on input.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.noqiflush">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">noqiflush</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.noqiflush" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>When the <code class="xref py py-func docutils literal notranslate"><span class="pre">noqiflush()</span></code> routine is used, normal flush of input and output queues
|
|||
|
|
associated with the <code class="docutils literal notranslate"><span class="pre">INTR</span></code>, <code class="docutils literal notranslate"><span class="pre">QUIT</span></code> and <code class="docutils literal notranslate"><span class="pre">SUSP</span></code> characters will not be done. You may
|
|||
|
|
want to call <code class="xref py py-func docutils literal notranslate"><span class="pre">noqiflush()</span></code> in a signal handler if you want output to
|
|||
|
|
continue as though the interrupt had not occurred, after the handler exits.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.noraw">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">noraw</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.noraw" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Leave raw mode. Return to normal “cooked” mode with line buffering.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.pair_content">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">pair_content</code><span class="sig-paren">(</span><em>pair_number</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.pair_content" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return a tuple <code class="docutils literal notranslate"><span class="pre">(fg,</span> <span class="pre">bg)</span></code> containing the colors for the requested color pair.
|
|||
|
|
The value of <em>pair_number</em> must be between <code class="docutils literal notranslate"><span class="pre">1</span></code> and <code class="docutils literal notranslate"><span class="pre">COLOR_PAIRS</span> <span class="pre">-</span> <span class="pre">1</span></code>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.pair_number">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">pair_number</code><span class="sig-paren">(</span><em>attr</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.pair_number" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return the number of the color-pair set by the attribute value <em>attr</em>.
|
|||
|
|
<a class="reference internal" href="#curses.color_pair" title="curses.color_pair"><code class="xref py py-func docutils literal notranslate"><span class="pre">color_pair()</span></code></a> is the counterpart to this function.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.putp">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">putp</code><span class="sig-paren">(</span><em>str</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.putp" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Equivalent to <code class="docutils literal notranslate"><span class="pre">tputs(str,</span> <span class="pre">1,</span> <span class="pre">putchar)</span></code>; emit the value of a specified
|
|||
|
|
terminfo capability for the current terminal. Note that the output of <a class="reference internal" href="#curses.putp" title="curses.putp"><code class="xref py py-func docutils literal notranslate"><span class="pre">putp()</span></code></a>
|
|||
|
|
always goes to standard output.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.qiflush">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">qiflush</code><span class="sig-paren">(</span><span class="optional">[</span><em>flag</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.qiflush" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>If <em>flag</em> is <code class="docutils literal notranslate"><span class="pre">False</span></code>, the effect is the same as calling <a class="reference internal" href="#curses.noqiflush" title="curses.noqiflush"><code class="xref py py-func docutils literal notranslate"><span class="pre">noqiflush()</span></code></a>. If
|
|||
|
|
<em>flag</em> is <code class="docutils literal notranslate"><span class="pre">True</span></code>, or no argument is provided, the queues will be flushed when
|
|||
|
|
these control characters are read.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.raw">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">raw</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.raw" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Enter raw mode. In raw mode, normal line buffering and processing of
|
|||
|
|
interrupt, quit, suspend, and flow control keys are turned off; characters are
|
|||
|
|
presented to curses input functions one by one.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.reset_prog_mode">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">reset_prog_mode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.reset_prog_mode" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Restore the terminal to “program” mode, as previously saved by
|
|||
|
|
<a class="reference internal" href="#curses.def_prog_mode" title="curses.def_prog_mode"><code class="xref py py-func docutils literal notranslate"><span class="pre">def_prog_mode()</span></code></a>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.reset_shell_mode">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">reset_shell_mode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.reset_shell_mode" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Restore the terminal to “shell” mode, as previously saved by
|
|||
|
|
<a class="reference internal" href="#curses.def_shell_mode" title="curses.def_shell_mode"><code class="xref py py-func docutils literal notranslate"><span class="pre">def_shell_mode()</span></code></a>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.resetty">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">resetty</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.resetty" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Restore the state of the terminal modes to what it was at the last call to
|
|||
|
|
<a class="reference internal" href="#curses.savetty" title="curses.savetty"><code class="xref py py-func docutils literal notranslate"><span class="pre">savetty()</span></code></a>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.resize_term">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">resize_term</code><span class="sig-paren">(</span><em>nlines</em>, <em>ncols</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.resize_term" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Backend function used by <a class="reference internal" href="#curses.resizeterm" title="curses.resizeterm"><code class="xref py py-func docutils literal notranslate"><span class="pre">resizeterm()</span></code></a>, performing most of the work;
|
|||
|
|
when resizing the windows, <a class="reference internal" href="#curses.resize_term" title="curses.resize_term"><code class="xref py py-func docutils literal notranslate"><span class="pre">resize_term()</span></code></a> blank-fills the areas that are
|
|||
|
|
extended. The calling application should fill in these areas with
|
|||
|
|
appropriate data. The <code class="xref py py-func docutils literal notranslate"><span class="pre">resize_term()</span></code> function attempts to resize all
|
|||
|
|
windows. However, due to the calling convention of pads, it is not possible
|
|||
|
|
to resize these without additional interaction with the application.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.resizeterm">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">resizeterm</code><span class="sig-paren">(</span><em>nlines</em>, <em>ncols</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.resizeterm" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Resize the standard and current windows to the specified dimensions, and
|
|||
|
|
adjusts other bookkeeping data used by the curses library that record the
|
|||
|
|
window dimensions (in particular the SIGWINCH handler).</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.savetty">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">savetty</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.savetty" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Save the current state of the terminal modes in a buffer, usable by
|
|||
|
|
<a class="reference internal" href="#curses.resetty" title="curses.resetty"><code class="xref py py-func docutils literal notranslate"><span class="pre">resetty()</span></code></a>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.setsyx">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">setsyx</code><span class="sig-paren">(</span><em>y</em>, <em>x</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.setsyx" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Set the virtual screen cursor to <em>y</em>, <em>x</em>. If <em>y</em> and <em>x</em> are both <code class="docutils literal notranslate"><span class="pre">-1</span></code>, then
|
|||
|
|
<a class="reference internal" href="#curses.window.leaveok" title="curses.window.leaveok"><code class="xref py py-meth docutils literal notranslate"><span class="pre">leaveok</span></code></a> is set <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.setupterm">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">setupterm</code><span class="sig-paren">(</span><em>term=None</em>, <em>fd=-1</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.setupterm" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Initialize the terminal. <em>term</em> is a string giving
|
|||
|
|
the terminal name, or <code class="docutils literal notranslate"><span class="pre">None</span></code>; if omitted or <code class="docutils literal notranslate"><span class="pre">None</span></code>, the value of the
|
|||
|
|
<span class="target" id="index-1"></span><code class="xref std std-envvar docutils literal notranslate"><span class="pre">TERM</span></code> environment variable will be used. <em>fd</em> is the
|
|||
|
|
file descriptor to which any initialization sequences will be sent; if not
|
|||
|
|
supplied or <code class="docutils literal notranslate"><span class="pre">-1</span></code>, the file descriptor for <code class="docutils literal notranslate"><span class="pre">sys.stdout</span></code> will be used.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.start_color">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">start_color</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.start_color" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Must be called if the programmer wants to use colors, and before any other color
|
|||
|
|
manipulation routine is called. It is good practice to call this routine right
|
|||
|
|
after <a class="reference internal" href="#curses.initscr" title="curses.initscr"><code class="xref py py-func docutils literal notranslate"><span class="pre">initscr()</span></code></a>.</p>
|
|||
|
|
<p><a class="reference internal" href="#curses.start_color" title="curses.start_color"><code class="xref py py-func docutils literal notranslate"><span class="pre">start_color()</span></code></a> initializes eight basic colors (black, red, green, yellow,
|
|||
|
|
blue, magenta, cyan, and white), and two global variables in the <a class="reference internal" href="#module-curses" title="curses: An interface to the curses library, providing portable terminal handling. (Unix)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">curses</span></code></a>
|
|||
|
|
module, <code class="xref py py-const docutils literal notranslate"><span class="pre">COLORS</span></code> and <code class="xref py py-const docutils literal notranslate"><span class="pre">COLOR_PAIRS</span></code>, containing the maximum number
|
|||
|
|
of colors and color-pairs the terminal can support. It also restores the colors
|
|||
|
|
on the terminal to the values they had when the terminal was just turned on.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.termattrs">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">termattrs</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.termattrs" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return a logical OR of all video attributes supported by the terminal. This
|
|||
|
|
information is useful when a curses program needs complete control over the
|
|||
|
|
appearance of the screen.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.termname">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">termname</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.termname" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return the value of the environment variable <span class="target" id="index-2"></span><code class="xref std std-envvar docutils literal notranslate"><span class="pre">TERM</span></code>, as a bytes object,
|
|||
|
|
truncated to 14 characters.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.tigetflag">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">tigetflag</code><span class="sig-paren">(</span><em>capname</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.tigetflag" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return the value of the Boolean capability corresponding to the terminfo
|
|||
|
|
capability name <em>capname</em> as an integer. Return the value <code class="docutils literal notranslate"><span class="pre">-1</span></code> if <em>capname</em> is not a
|
|||
|
|
Boolean capability, or <code class="docutils literal notranslate"><span class="pre">0</span></code> if it is canceled or absent from the terminal
|
|||
|
|
description.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.tigetnum">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">tigetnum</code><span class="sig-paren">(</span><em>capname</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.tigetnum" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return the value of the numeric capability corresponding to the terminfo
|
|||
|
|
capability name <em>capname</em> as an integer. Return the value <code class="docutils literal notranslate"><span class="pre">-2</span></code> if <em>capname</em> is not a
|
|||
|
|
numeric capability, or <code class="docutils literal notranslate"><span class="pre">-1</span></code> if it is canceled or absent from the terminal
|
|||
|
|
description.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.tigetstr">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">tigetstr</code><span class="sig-paren">(</span><em>capname</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.tigetstr" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return the value of the string capability corresponding to the terminfo
|
|||
|
|
capability name <em>capname</em> as a bytes object. Return <code class="docutils literal notranslate"><span class="pre">None</span></code> if <em>capname</em>
|
|||
|
|
is not a terminfo “string capability”, or is canceled or absent from the
|
|||
|
|
terminal description.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.tparm">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">tparm</code><span class="sig-paren">(</span><em>str</em><span class="optional">[</span>, <em>...</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.tparm" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Instantiate the bytes object <em>str</em> with the supplied parameters, where <em>str</em> should
|
|||
|
|
be a parameterized string obtained from the terminfo database. E.g.
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">tparm(tigetstr("cup"),</span> <span class="pre">5,</span> <span class="pre">3)</span></code> could result in <code class="docutils literal notranslate"><span class="pre">b'\033[6;4H'</span></code>, the exact
|
|||
|
|
result depending on terminal type.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.typeahead">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">typeahead</code><span class="sig-paren">(</span><em>fd</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.typeahead" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Specify that the file descriptor <em>fd</em> be used for typeahead checking. If <em>fd</em>
|
|||
|
|
is <code class="docutils literal notranslate"><span class="pre">-1</span></code>, then no typeahead checking is done.</p>
|
|||
|
|
<p>The curses library does “line-breakout optimization” by looking for typeahead
|
|||
|
|
periodically while updating the screen. If input is found, and it is coming
|
|||
|
|
from a tty, the current update is postponed until refresh or doupdate is called
|
|||
|
|
again, allowing faster response to commands typed in advance. This function
|
|||
|
|
allows specifying a different file descriptor for typeahead checking.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.unctrl">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">unctrl</code><span class="sig-paren">(</span><em>ch</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.unctrl" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return a bytes object which is a printable representation of the character <em>ch</em>.
|
|||
|
|
Control characters are represented as a caret followed by the character, for
|
|||
|
|
example as <code class="docutils literal notranslate"><span class="pre">b'^C'</span></code>. Printing characters are left as they are.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.ungetch">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">ungetch</code><span class="sig-paren">(</span><em>ch</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.ungetch" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Push <em>ch</em> so the next <a class="reference internal" href="#curses.window.getch" title="curses.window.getch"><code class="xref py py-meth docutils literal notranslate"><span class="pre">getch()</span></code></a> will return it.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>Only one <em>ch</em> can be pushed before <code class="xref py py-meth docutils literal notranslate"><span class="pre">getch()</span></code> is called.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.update_lines_cols">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">update_lines_cols</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.update_lines_cols" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Update <span class="target" id="index-3"></span><code class="xref std std-envvar docutils literal notranslate"><span class="pre">LINES</span></code> and <span class="target" id="index-4"></span><code class="xref std std-envvar docutils literal notranslate"><span class="pre">COLS</span></code>. Useful for detecting manual screen resize.</p>
|
|||
|
|
<div class="versionadded">
|
|||
|
|
<p><span class="versionmodified added">New in version 3.5.</span></p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.unget_wch">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">unget_wch</code><span class="sig-paren">(</span><em>ch</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.unget_wch" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Push <em>ch</em> so the next <a class="reference internal" href="#curses.window.get_wch" title="curses.window.get_wch"><code class="xref py py-meth docutils literal notranslate"><span class="pre">get_wch()</span></code></a> will return it.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>Only one <em>ch</em> can be pushed before <code class="xref py py-meth docutils literal notranslate"><span class="pre">get_wch()</span></code> is called.</p>
|
|||
|
|
</div>
|
|||
|
|
<div class="versionadded">
|
|||
|
|
<p><span class="versionmodified added">New in version 3.3.</span></p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.ungetmouse">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">ungetmouse</code><span class="sig-paren">(</span><em>id</em>, <em>x</em>, <em>y</em>, <em>z</em>, <em>bstate</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.ungetmouse" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Push a <code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_MOUSE</span></code> event onto the input queue, associating the given
|
|||
|
|
state data with it.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.use_env">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">use_env</code><span class="sig-paren">(</span><em>flag</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.use_env" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>If used, this function should be called before <a class="reference internal" href="#curses.initscr" title="curses.initscr"><code class="xref py py-func docutils literal notranslate"><span class="pre">initscr()</span></code></a> or newterm are
|
|||
|
|
called. When <em>flag</em> is <code class="docutils literal notranslate"><span class="pre">False</span></code>, the values of lines and columns specified in the
|
|||
|
|
terminfo database will be used, even if environment variables <span class="target" id="index-5"></span><code class="xref std std-envvar docutils literal notranslate"><span class="pre">LINES</span></code>
|
|||
|
|
and <span class="target" id="index-6"></span><code class="xref std std-envvar docutils literal notranslate"><span class="pre">COLUMNS</span></code> (used by default) are set, or if curses is running in a
|
|||
|
|
window (in which case default behavior would be to use the window size if
|
|||
|
|
<span class="target" id="index-7"></span><code class="xref std std-envvar docutils literal notranslate"><span class="pre">LINES</span></code> and <span class="target" id="index-8"></span><code class="xref std std-envvar docutils literal notranslate"><span class="pre">COLUMNS</span></code> are not set).</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.use_default_colors">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">use_default_colors</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.use_default_colors" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Allow use of default values for colors on terminals supporting this feature. Use
|
|||
|
|
this to support transparency in your application. The default color is assigned
|
|||
|
|
to the color number <code class="docutils literal notranslate"><span class="pre">-1</span></code>. After calling this function, <code class="docutils literal notranslate"><span class="pre">init_pair(x,</span>
|
|||
|
|
<span class="pre">curses.COLOR_RED,</span> <span class="pre">-1)</span></code> initializes, for instance, color pair <em>x</em> to a red
|
|||
|
|
foreground color on the default background.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.wrapper">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">wrapper</code><span class="sig-paren">(</span><em>func</em>, <em>...</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.wrapper" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Initialize curses and call another callable object, <em>func</em>, which should be the
|
|||
|
|
rest of your curses-using application. If the application raises an exception,
|
|||
|
|
this function will restore the terminal to a sane state before re-raising the
|
|||
|
|
exception and generating a traceback. The callable object <em>func</em> is then passed
|
|||
|
|
the main window ‘stdscr’ as its first argument, followed by any other arguments
|
|||
|
|
passed to <code class="xref py py-func docutils literal notranslate"><span class="pre">wrapper()</span></code>. Before calling <em>func</em>, <code class="xref py py-func docutils literal notranslate"><span class="pre">wrapper()</span></code> turns on
|
|||
|
|
cbreak mode, turns off echo, enables the terminal keypad, and initializes colors
|
|||
|
|
if the terminal has color support. On exit (whether normally or by exception)
|
|||
|
|
it restores cooked mode, turns on echo, and disables the terminal keypad.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="window-objects">
|
|||
|
|
<span id="curses-window-objects"></span><h2>Window Objects<a class="headerlink" href="#window-objects" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>Window objects, as returned by <a class="reference internal" href="#curses.initscr" title="curses.initscr"><code class="xref py py-func docutils literal notranslate"><span class="pre">initscr()</span></code></a> and <a class="reference internal" href="#curses.newwin" title="curses.newwin"><code class="xref py py-func docutils literal notranslate"><span class="pre">newwin()</span></code></a> above, have
|
|||
|
|
the following methods and attributes:</p>
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.addch">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">addch</code><span class="sig-paren">(</span><em>ch</em><span class="optional">[</span>, <em>attr</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.addch" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dt>
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">addch</code><span class="sig-paren">(</span><em>y</em>, <em>x</em>, <em>ch</em><span class="optional">[</span>, <em>attr</em><span class="optional">]</span><span class="sig-paren">)</span></dt>
|
|||
|
|
<dd><p>Paint character <em>ch</em> at <code class="docutils literal notranslate"><span class="pre">(y,</span> <span class="pre">x)</span></code> with attributes <em>attr</em>, overwriting any
|
|||
|
|
character previously painter at that location. By default, the character
|
|||
|
|
position and attributes are the current settings for the window object.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>Writing outside the window, subwindow, or pad raises a <a class="reference internal" href="#curses.error" title="curses.error"><code class="xref py py-exc docutils literal notranslate"><span class="pre">curses.error</span></code></a>.
|
|||
|
|
Attempting to write to the lower right corner of a window, subwindow,
|
|||
|
|
or pad will cause an exception to be raised after the character is printed.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.addnstr">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">addnstr</code><span class="sig-paren">(</span><em>str</em>, <em>n</em><span class="optional">[</span>, <em>attr</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.addnstr" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dt>
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">addnstr</code><span class="sig-paren">(</span><em>y</em>, <em>x</em>, <em>str</em>, <em>n</em><span class="optional">[</span>, <em>attr</em><span class="optional">]</span><span class="sig-paren">)</span></dt>
|
|||
|
|
<dd><p>Paint at most <em>n</em> characters of the character string <em>str</em> at
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">(y,</span> <span class="pre">x)</span></code> with attributes
|
|||
|
|
<em>attr</em>, overwriting anything previously on the display.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.addstr">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">addstr</code><span class="sig-paren">(</span><em>str</em><span class="optional">[</span>, <em>attr</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.addstr" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dt>
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">addstr</code><span class="sig-paren">(</span><em>y</em>, <em>x</em>, <em>str</em><span class="optional">[</span>, <em>attr</em><span class="optional">]</span><span class="sig-paren">)</span></dt>
|
|||
|
|
<dd><p>Paint the character string <em>str</em> at <code class="docutils literal notranslate"><span class="pre">(y,</span> <span class="pre">x)</span></code> with attributes
|
|||
|
|
<em>attr</em>, overwriting anything previously on the display.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>Writing outside the window, subwindow, or pad raises <a class="reference internal" href="#curses.error" title="curses.error"><code class="xref py py-exc docutils literal notranslate"><span class="pre">curses.error</span></code></a>.
|
|||
|
|
Attempting to write to the lower right corner of a window, subwindow,
|
|||
|
|
or pad will cause an exception to be raised after the string is printed.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.attroff">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">attroff</code><span class="sig-paren">(</span><em>attr</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.attroff" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Remove attribute <em>attr</em> from the “background” set applied to all writes to the
|
|||
|
|
current window.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.attron">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">attron</code><span class="sig-paren">(</span><em>attr</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.attron" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Add attribute <em>attr</em> from the “background” set applied to all writes to the
|
|||
|
|
current window.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.attrset">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">attrset</code><span class="sig-paren">(</span><em>attr</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.attrset" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Set the “background” set of attributes to <em>attr</em>. This set is initially
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">0</span></code> (no attributes).</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.bkgd">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">bkgd</code><span class="sig-paren">(</span><em>ch</em><span class="optional">[</span>, <em>attr</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.bkgd" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Set the background property of the window to the character <em>ch</em>, with
|
|||
|
|
attributes <em>attr</em>. The change is then applied to every character position in
|
|||
|
|
that window:</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>The attribute of every character in the window is changed to the new
|
|||
|
|
background attribute.</p></li>
|
|||
|
|
<li><p>Wherever the former background character appears, it is changed to the new
|
|||
|
|
background character.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.bkgdset">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">bkgdset</code><span class="sig-paren">(</span><em>ch</em><span class="optional">[</span>, <em>attr</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.bkgdset" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Set the window’s background. A window’s background consists of a character and
|
|||
|
|
any combination of attributes. The attribute part of the background is combined
|
|||
|
|
(OR’ed) with all non-blank characters that are written into the window. Both
|
|||
|
|
the character and attribute parts of the background are combined with the blank
|
|||
|
|
characters. The background becomes a property of the character and moves with
|
|||
|
|
the character through any scrolling and insert/delete line/character operations.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.border">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">border</code><span class="sig-paren">(</span><span class="optional">[</span><em>ls</em><span class="optional">[</span>, <em>rs</em><span class="optional">[</span>, <em>ts</em><span class="optional">[</span>, <em>bs</em><span class="optional">[</span>, <em>tl</em><span class="optional">[</span>, <em>tr</em><span class="optional">[</span>, <em>bl</em><span class="optional">[</span>, <em>br</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.border" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Draw a border around the edges of the window. Each parameter specifies the
|
|||
|
|
character to use for a specific part of the border; see the table below for more
|
|||
|
|
details.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>A <code class="docutils literal notranslate"><span class="pre">0</span></code> value for any parameter will cause the default character to be used for
|
|||
|
|
that parameter. Keyword parameters can <em>not</em> be used. The defaults are listed
|
|||
|
|
in this table:</p>
|
|||
|
|
</div>
|
|||
|
|
<table class="docutils align-center">
|
|||
|
|
<colgroup>
|
|||
|
|
<col style="width: 20%" />
|
|||
|
|
<col style="width: 38%" />
|
|||
|
|
<col style="width: 42%" />
|
|||
|
|
</colgroup>
|
|||
|
|
<thead>
|
|||
|
|
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
|||
|
|
<th class="head"><p>Description</p></th>
|
|||
|
|
<th class="head"><p>Default value</p></th>
|
|||
|
|
</tr>
|
|||
|
|
</thead>
|
|||
|
|
<tbody>
|
|||
|
|
<tr class="row-even"><td><p><em>ls</em></p></td>
|
|||
|
|
<td><p>Left side</p></td>
|
|||
|
|
<td><p><code class="xref py py-const docutils literal notranslate"><span class="pre">ACS_VLINE</span></code></p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><em>rs</em></p></td>
|
|||
|
|
<td><p>Right side</p></td>
|
|||
|
|
<td><p><code class="xref py py-const docutils literal notranslate"><span class="pre">ACS_VLINE</span></code></p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><em>ts</em></p></td>
|
|||
|
|
<td><p>Top</p></td>
|
|||
|
|
<td><p><code class="xref py py-const docutils literal notranslate"><span class="pre">ACS_HLINE</span></code></p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><em>bs</em></p></td>
|
|||
|
|
<td><p>Bottom</p></td>
|
|||
|
|
<td><p><code class="xref py py-const docutils literal notranslate"><span class="pre">ACS_HLINE</span></code></p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><em>tl</em></p></td>
|
|||
|
|
<td><p>Upper-left corner</p></td>
|
|||
|
|
<td><p><code class="xref py py-const docutils literal notranslate"><span class="pre">ACS_ULCORNER</span></code></p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><em>tr</em></p></td>
|
|||
|
|
<td><p>Upper-right corner</p></td>
|
|||
|
|
<td><p><code class="xref py py-const docutils literal notranslate"><span class="pre">ACS_URCORNER</span></code></p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><em>bl</em></p></td>
|
|||
|
|
<td><p>Bottom-left corner</p></td>
|
|||
|
|
<td><p><code class="xref py py-const docutils literal notranslate"><span class="pre">ACS_LLCORNER</span></code></p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><em>br</em></p></td>
|
|||
|
|
<td><p>Bottom-right corner</p></td>
|
|||
|
|
<td><p><code class="xref py py-const docutils literal notranslate"><span class="pre">ACS_LRCORNER</span></code></p></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.box">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">box</code><span class="sig-paren">(</span><span class="optional">[</span><em>vertch</em>, <em>horch</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.box" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Similar to <a class="reference internal" href="#curses.window.border" title="curses.window.border"><code class="xref py py-meth docutils literal notranslate"><span class="pre">border()</span></code></a>, but both <em>ls</em> and <em>rs</em> are <em>vertch</em> and both <em>ts</em> and
|
|||
|
|
<em>bs</em> are <em>horch</em>. The default corner characters are always used by this function.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.chgat">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">chgat</code><span class="sig-paren">(</span><em>attr</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.chgat" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dt>
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">chgat</code><span class="sig-paren">(</span><em>num</em>, <em>attr</em><span class="sig-paren">)</span></dt>
|
|||
|
|
<dt>
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">chgat</code><span class="sig-paren">(</span><em>y</em>, <em>x</em>, <em>attr</em><span class="sig-paren">)</span></dt>
|
|||
|
|
<dt>
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">chgat</code><span class="sig-paren">(</span><em>y</em>, <em>x</em>, <em>num</em>, <em>attr</em><span class="sig-paren">)</span></dt>
|
|||
|
|
<dd><p>Set the attributes of <em>num</em> characters at the current cursor position, or at
|
|||
|
|
position <code class="docutils literal notranslate"><span class="pre">(y,</span> <span class="pre">x)</span></code> if supplied. If <em>num</em> is not given or is <code class="docutils literal notranslate"><span class="pre">-1</span></code>,
|
|||
|
|
the attribute will be set on all the characters to the end of the line. This
|
|||
|
|
function moves cursor to position <code class="docutils literal notranslate"><span class="pre">(y,</span> <span class="pre">x)</span></code> if supplied. The changed line
|
|||
|
|
will be touched using the <a class="reference internal" href="#curses.window.touchline" title="curses.window.touchline"><code class="xref py py-meth docutils literal notranslate"><span class="pre">touchline()</span></code></a> method so that the contents will
|
|||
|
|
be redisplayed by the next window refresh.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.clear">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">clear</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.clear" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Like <a class="reference internal" href="#curses.window.erase" title="curses.window.erase"><code class="xref py py-meth docutils literal notranslate"><span class="pre">erase()</span></code></a>, but also cause the whole window to be repainted upon next
|
|||
|
|
call to <a class="reference internal" href="#curses.window.refresh" title="curses.window.refresh"><code class="xref py py-meth docutils literal notranslate"><span class="pre">refresh()</span></code></a>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.clearok">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">clearok</code><span class="sig-paren">(</span><em>flag</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.clearok" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>If <em>flag</em> is <code class="docutils literal notranslate"><span class="pre">True</span></code>, the next call to <a class="reference internal" href="#curses.window.refresh" title="curses.window.refresh"><code class="xref py py-meth docutils literal notranslate"><span class="pre">refresh()</span></code></a> will clear the window
|
|||
|
|
completely.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.clrtobot">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">clrtobot</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.clrtobot" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Erase from cursor to the end of the window: all lines below the cursor are
|
|||
|
|
deleted, and then the equivalent of <a class="reference internal" href="#curses.window.clrtoeol" title="curses.window.clrtoeol"><code class="xref py py-meth docutils literal notranslate"><span class="pre">clrtoeol()</span></code></a> is performed.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.clrtoeol">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">clrtoeol</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.clrtoeol" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Erase from cursor to the end of the line.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.cursyncup">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">cursyncup</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.cursyncup" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Update the current cursor position of all the ancestors of the window to
|
|||
|
|
reflect the current cursor position of the window.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.delch">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">delch</code><span class="sig-paren">(</span><span class="optional">[</span><em>y</em>, <em>x</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.delch" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Delete any character at <code class="docutils literal notranslate"><span class="pre">(y,</span> <span class="pre">x)</span></code>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.deleteln">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">deleteln</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.deleteln" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Delete the line under the cursor. All following lines are moved up by one line.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.derwin">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">derwin</code><span class="sig-paren">(</span><em>begin_y</em>, <em>begin_x</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.derwin" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dt>
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">derwin</code><span class="sig-paren">(</span><em>nlines</em>, <em>ncols</em>, <em>begin_y</em>, <em>begin_x</em><span class="sig-paren">)</span></dt>
|
|||
|
|
<dd><p>An abbreviation for “derive window”, <a class="reference internal" href="#curses.window.derwin" title="curses.window.derwin"><code class="xref py py-meth docutils literal notranslate"><span class="pre">derwin()</span></code></a> is the same as calling
|
|||
|
|
<a class="reference internal" href="#curses.window.subwin" title="curses.window.subwin"><code class="xref py py-meth docutils literal notranslate"><span class="pre">subwin()</span></code></a>, except that <em>begin_y</em> and <em>begin_x</em> are relative to the origin
|
|||
|
|
of the window, rather than relative to the entire screen. Return a window
|
|||
|
|
object for the derived window.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.echochar">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">echochar</code><span class="sig-paren">(</span><em>ch</em><span class="optional">[</span>, <em>attr</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.echochar" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Add character <em>ch</em> with attribute <em>attr</em>, and immediately call <a class="reference internal" href="#curses.window.refresh" title="curses.window.refresh"><code class="xref py py-meth docutils literal notranslate"><span class="pre">refresh()</span></code></a>
|
|||
|
|
on the window.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.enclose">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">enclose</code><span class="sig-paren">(</span><em>y</em>, <em>x</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.enclose" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Test whether the given pair of screen-relative character-cell coordinates are
|
|||
|
|
enclosed by the given window, returning <code class="docutils literal notranslate"><span class="pre">True</span></code> or <code class="docutils literal notranslate"><span class="pre">False</span></code>. It is useful for
|
|||
|
|
determining what subset of the screen windows enclose the location of a mouse
|
|||
|
|
event.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="curses.window.encoding">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">encoding</code><a class="headerlink" href="#curses.window.encoding" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Encoding used to encode method arguments (Unicode strings and characters).
|
|||
|
|
The encoding attribute is inherited from the parent window when a subwindow
|
|||
|
|
is created, for example with <a class="reference internal" href="#curses.window.subwin" title="curses.window.subwin"><code class="xref py py-meth docutils literal notranslate"><span class="pre">window.subwin()</span></code></a>. By default, the locale
|
|||
|
|
encoding is used (see <a class="reference internal" href="locale.html#locale.getpreferredencoding" title="locale.getpreferredencoding"><code class="xref py py-func docutils literal notranslate"><span class="pre">locale.getpreferredencoding()</span></code></a>).</p>
|
|||
|
|
<div class="versionadded">
|
|||
|
|
<p><span class="versionmodified added">New in version 3.3.</span></p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.erase">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">erase</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.erase" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Clear the window.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.getbegyx">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">getbegyx</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.getbegyx" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return a tuple <code class="docutils literal notranslate"><span class="pre">(y,</span> <span class="pre">x)</span></code> of co-ordinates of upper-left corner.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.getbkgd">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">getbkgd</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.getbkgd" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return the given window’s current background character/attribute pair.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.getch">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">getch</code><span class="sig-paren">(</span><span class="optional">[</span><em>y</em>, <em>x</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.getch" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Get a character. Note that the integer returned does <em>not</em> have to be in ASCII
|
|||
|
|
range: function keys, keypad keys and so on are represented by numbers higher
|
|||
|
|
than 255. In no-delay mode, return <code class="docutils literal notranslate"><span class="pre">-1</span></code> if there is no input, otherwise
|
|||
|
|
wait until a key is pressed.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.get_wch">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">get_wch</code><span class="sig-paren">(</span><span class="optional">[</span><em>y</em>, <em>x</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.get_wch" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Get a wide character. Return a character for most keys, or an integer for
|
|||
|
|
function keys, keypad keys, and other special keys.
|
|||
|
|
In no-delay mode, raise an exception if there is no input.</p>
|
|||
|
|
<div class="versionadded">
|
|||
|
|
<p><span class="versionmodified added">New in version 3.3.</span></p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.getkey">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">getkey</code><span class="sig-paren">(</span><span class="optional">[</span><em>y</em>, <em>x</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.getkey" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Get a character, returning a string instead of an integer, as <a class="reference internal" href="#curses.window.getch" title="curses.window.getch"><code class="xref py py-meth docutils literal notranslate"><span class="pre">getch()</span></code></a>
|
|||
|
|
does. Function keys, keypad keys and other special keys return a multibyte
|
|||
|
|
string containing the key name. In no-delay mode, raise an exception if
|
|||
|
|
there is no input.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.getmaxyx">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">getmaxyx</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.getmaxyx" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return a tuple <code class="docutils literal notranslate"><span class="pre">(y,</span> <span class="pre">x)</span></code> of the height and width of the window.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.getparyx">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">getparyx</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.getparyx" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return the beginning coordinates of this window relative to its parent window
|
|||
|
|
as a tuple <code class="docutils literal notranslate"><span class="pre">(y,</span> <span class="pre">x)</span></code>. Return <code class="docutils literal notranslate"><span class="pre">(-1,</span> <span class="pre">-1)</span></code> if this window has no
|
|||
|
|
parent.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.getstr">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">getstr</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.getstr" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dt>
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">getstr</code><span class="sig-paren">(</span><em>n</em><span class="sig-paren">)</span></dt>
|
|||
|
|
<dt>
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">getstr</code><span class="sig-paren">(</span><em>y</em>, <em>x</em><span class="sig-paren">)</span></dt>
|
|||
|
|
<dt>
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">getstr</code><span class="sig-paren">(</span><em>y</em>, <em>x</em>, <em>n</em><span class="sig-paren">)</span></dt>
|
|||
|
|
<dd><p>Read a bytes object from the user, with primitive line editing capacity.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.getyx">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">getyx</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.getyx" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return a tuple <code class="docutils literal notranslate"><span class="pre">(y,</span> <span class="pre">x)</span></code> of current cursor position relative to the window’s
|
|||
|
|
upper-left corner.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.hline">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">hline</code><span class="sig-paren">(</span><em>ch</em>, <em>n</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.hline" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dt>
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">hline</code><span class="sig-paren">(</span><em>y</em>, <em>x</em>, <em>ch</em>, <em>n</em><span class="sig-paren">)</span></dt>
|
|||
|
|
<dd><p>Display a horizontal line starting at <code class="docutils literal notranslate"><span class="pre">(y,</span> <span class="pre">x)</span></code> with length <em>n</em> consisting of
|
|||
|
|
the character <em>ch</em>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.idcok">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">idcok</code><span class="sig-paren">(</span><em>flag</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.idcok" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>If <em>flag</em> is <code class="docutils literal notranslate"><span class="pre">False</span></code>, curses no longer considers using the hardware insert/delete
|
|||
|
|
character feature of the terminal; if <em>flag</em> is <code class="docutils literal notranslate"><span class="pre">True</span></code>, use of character insertion
|
|||
|
|
and deletion is enabled. When curses is first initialized, use of character
|
|||
|
|
insert/delete is enabled by default.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.idlok">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">idlok</code><span class="sig-paren">(</span><em>flag</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.idlok" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>If <em>flag</em> is <code class="docutils literal notranslate"><span class="pre">True</span></code>, <a class="reference internal" href="#module-curses" title="curses: An interface to the curses library, providing portable terminal handling. (Unix)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">curses</span></code></a> will try and use hardware line
|
|||
|
|
editing facilities. Otherwise, line insertion/deletion are disabled.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.immedok">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">immedok</code><span class="sig-paren">(</span><em>flag</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.immedok" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>If <em>flag</em> is <code class="docutils literal notranslate"><span class="pre">True</span></code>, any change in the window image automatically causes the
|
|||
|
|
window to be refreshed; you no longer have to call <a class="reference internal" href="#curses.window.refresh" title="curses.window.refresh"><code class="xref py py-meth docutils literal notranslate"><span class="pre">refresh()</span></code></a> yourself.
|
|||
|
|
However, it may degrade performance considerably, due to repeated calls to
|
|||
|
|
wrefresh. This option is disabled by default.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.inch">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">inch</code><span class="sig-paren">(</span><span class="optional">[</span><em>y</em>, <em>x</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.inch" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return the character at the given position in the window. The bottom 8 bits are
|
|||
|
|
the character proper, and upper bits are the attributes.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.insch">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">insch</code><span class="sig-paren">(</span><em>ch</em><span class="optional">[</span>, <em>attr</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.insch" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dt>
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">insch</code><span class="sig-paren">(</span><em>y</em>, <em>x</em>, <em>ch</em><span class="optional">[</span>, <em>attr</em><span class="optional">]</span><span class="sig-paren">)</span></dt>
|
|||
|
|
<dd><p>Paint character <em>ch</em> at <code class="docutils literal notranslate"><span class="pre">(y,</span> <span class="pre">x)</span></code> with attributes <em>attr</em>, moving the line from
|
|||
|
|
position <em>x</em> right by one character.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.insdelln">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">insdelln</code><span class="sig-paren">(</span><em>nlines</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.insdelln" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Insert <em>nlines</em> lines into the specified window above the current line. The
|
|||
|
|
<em>nlines</em> bottom lines are lost. For negative <em>nlines</em>, delete <em>nlines</em> lines
|
|||
|
|
starting with the one under the cursor, and move the remaining lines up. The
|
|||
|
|
bottom <em>nlines</em> lines are cleared. The current cursor position remains the
|
|||
|
|
same.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.insertln">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">insertln</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.insertln" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Insert a blank line under the cursor. All following lines are moved down by one
|
|||
|
|
line.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.insnstr">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">insnstr</code><span class="sig-paren">(</span><em>str</em>, <em>n</em><span class="optional">[</span>, <em>attr</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.insnstr" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dt>
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">insnstr</code><span class="sig-paren">(</span><em>y</em>, <em>x</em>, <em>str</em>, <em>n</em><span class="optional">[</span>, <em>attr</em><span class="optional">]</span><span class="sig-paren">)</span></dt>
|
|||
|
|
<dd><p>Insert a character string (as many characters as will fit on the line) before
|
|||
|
|
the character under the cursor, up to <em>n</em> characters. If <em>n</em> is zero or
|
|||
|
|
negative, the entire string is inserted. All characters to the right of the
|
|||
|
|
cursor are shifted right, with the rightmost characters on the line being lost.
|
|||
|
|
The cursor position does not change (after moving to <em>y</em>, <em>x</em>, if specified).</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.insstr">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">insstr</code><span class="sig-paren">(</span><em>str</em><span class="optional">[</span>, <em>attr</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.insstr" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dt>
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">insstr</code><span class="sig-paren">(</span><em>y</em>, <em>x</em>, <em>str</em><span class="optional">[</span>, <em>attr</em><span class="optional">]</span><span class="sig-paren">)</span></dt>
|
|||
|
|
<dd><p>Insert a character string (as many characters as will fit on the line) before
|
|||
|
|
the character under the cursor. All characters to the right of the cursor are
|
|||
|
|
shifted right, with the rightmost characters on the line being lost. The cursor
|
|||
|
|
position does not change (after moving to <em>y</em>, <em>x</em>, if specified).</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.instr">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">instr</code><span class="sig-paren">(</span><span class="optional">[</span><em>n</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.instr" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dt>
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">instr</code><span class="sig-paren">(</span><em>y</em>, <em>x</em><span class="optional">[</span>, <em>n</em><span class="optional">]</span><span class="sig-paren">)</span></dt>
|
|||
|
|
<dd><p>Return a bytes object of characters, extracted from the window starting at the
|
|||
|
|
current cursor position, or at <em>y</em>, <em>x</em> if specified. Attributes are stripped
|
|||
|
|
from the characters. If <em>n</em> is specified, <a class="reference internal" href="#curses.window.instr" title="curses.window.instr"><code class="xref py py-meth docutils literal notranslate"><span class="pre">instr()</span></code></a> returns a string
|
|||
|
|
at most <em>n</em> characters long (exclusive of the trailing NUL).</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.is_linetouched">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">is_linetouched</code><span class="sig-paren">(</span><em>line</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.is_linetouched" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the specified line was modified since the last call to
|
|||
|
|
<a class="reference internal" href="#curses.window.refresh" title="curses.window.refresh"><code class="xref py py-meth docutils literal notranslate"><span class="pre">refresh()</span></code></a>; otherwise return <code class="docutils literal notranslate"><span class="pre">False</span></code>. Raise a <a class="reference internal" href="#curses.error" title="curses.error"><code class="xref py py-exc docutils literal notranslate"><span class="pre">curses.error</span></code></a>
|
|||
|
|
exception if <em>line</em> is not valid for the given window.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.is_wintouched">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">is_wintouched</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.is_wintouched" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the specified window was modified since the last call to
|
|||
|
|
<a class="reference internal" href="#curses.window.refresh" title="curses.window.refresh"><code class="xref py py-meth docutils literal notranslate"><span class="pre">refresh()</span></code></a>; otherwise return <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.keypad">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">keypad</code><span class="sig-paren">(</span><em>flag</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.keypad" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>If <em>flag</em> is <code class="docutils literal notranslate"><span class="pre">True</span></code>, escape sequences generated by some keys (keypad, function keys)
|
|||
|
|
will be interpreted by <a class="reference internal" href="#module-curses" title="curses: An interface to the curses library, providing portable terminal handling. (Unix)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">curses</span></code></a>. If <em>flag</em> is <code class="docutils literal notranslate"><span class="pre">False</span></code>, escape sequences will be
|
|||
|
|
left as is in the input stream.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.leaveok">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">leaveok</code><span class="sig-paren">(</span><em>flag</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.leaveok" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>If <em>flag</em> is <code class="docutils literal notranslate"><span class="pre">True</span></code>, cursor is left where it is on update, instead of being at “cursor
|
|||
|
|
position.” This reduces cursor movement where possible. If possible the cursor
|
|||
|
|
will be made invisible.</p>
|
|||
|
|
<p>If <em>flag</em> is <code class="docutils literal notranslate"><span class="pre">False</span></code>, cursor will always be at “cursor position” after an update.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.move">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">move</code><span class="sig-paren">(</span><em>new_y</em>, <em>new_x</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.move" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Move cursor to <code class="docutils literal notranslate"><span class="pre">(new_y,</span> <span class="pre">new_x)</span></code>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.mvderwin">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">mvderwin</code><span class="sig-paren">(</span><em>y</em>, <em>x</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.mvderwin" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Move the window inside its parent window. The screen-relative parameters of
|
|||
|
|
the window are not changed. This routine is used to display different parts of
|
|||
|
|
the parent window at the same physical position on the screen.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.mvwin">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">mvwin</code><span class="sig-paren">(</span><em>new_y</em>, <em>new_x</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.mvwin" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Move the window so its upper-left corner is at <code class="docutils literal notranslate"><span class="pre">(new_y,</span> <span class="pre">new_x)</span></code>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.nodelay">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">nodelay</code><span class="sig-paren">(</span><em>flag</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.nodelay" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>If <em>flag</em> is <code class="docutils literal notranslate"><span class="pre">True</span></code>, <a class="reference internal" href="#curses.window.getch" title="curses.window.getch"><code class="xref py py-meth docutils literal notranslate"><span class="pre">getch()</span></code></a> will be non-blocking.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.notimeout">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">notimeout</code><span class="sig-paren">(</span><em>flag</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.notimeout" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>If <em>flag</em> is <code class="docutils literal notranslate"><span class="pre">True</span></code>, escape sequences will not be timed out.</p>
|
|||
|
|
<p>If <em>flag</em> is <code class="docutils literal notranslate"><span class="pre">False</span></code>, after a few milliseconds, an escape sequence will not be
|
|||
|
|
interpreted, and will be left in the input stream as is.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.noutrefresh">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">noutrefresh</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.noutrefresh" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Mark for refresh but wait. This function updates the data structure
|
|||
|
|
representing the desired state of the window, but does not force an update of
|
|||
|
|
the physical screen. To accomplish that, call <a class="reference internal" href="#curses.doupdate" title="curses.doupdate"><code class="xref py py-func docutils literal notranslate"><span class="pre">doupdate()</span></code></a>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.overlay">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">overlay</code><span class="sig-paren">(</span><em>destwin</em><span class="optional">[</span>, <em>sminrow</em>, <em>smincol</em>, <em>dminrow</em>, <em>dmincol</em>, <em>dmaxrow</em>, <em>dmaxcol</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.overlay" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Overlay the window on top of <em>destwin</em>. The windows need not be the same size,
|
|||
|
|
only the overlapping region is copied. This copy is non-destructive, which means
|
|||
|
|
that the current background character does not overwrite the old contents of
|
|||
|
|
<em>destwin</em>.</p>
|
|||
|
|
<p>To get fine-grained control over the copied region, the second form of
|
|||
|
|
<a class="reference internal" href="#curses.window.overlay" title="curses.window.overlay"><code class="xref py py-meth docutils literal notranslate"><span class="pre">overlay()</span></code></a> can be used. <em>sminrow</em> and <em>smincol</em> are the upper-left
|
|||
|
|
coordinates of the source window, and the other variables mark a rectangle in
|
|||
|
|
the destination window.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.overwrite">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">overwrite</code><span class="sig-paren">(</span><em>destwin</em><span class="optional">[</span>, <em>sminrow</em>, <em>smincol</em>, <em>dminrow</em>, <em>dmincol</em>, <em>dmaxrow</em>, <em>dmaxcol</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.overwrite" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Overwrite the window on top of <em>destwin</em>. The windows need not be the same size,
|
|||
|
|
in which case only the overlapping region is copied. This copy is destructive,
|
|||
|
|
which means that the current background character overwrites the old contents of
|
|||
|
|
<em>destwin</em>.</p>
|
|||
|
|
<p>To get fine-grained control over the copied region, the second form of
|
|||
|
|
<a class="reference internal" href="#curses.window.overwrite" title="curses.window.overwrite"><code class="xref py py-meth docutils literal notranslate"><span class="pre">overwrite()</span></code></a> can be used. <em>sminrow</em> and <em>smincol</em> are the upper-left
|
|||
|
|
coordinates of the source window, the other variables mark a rectangle in the
|
|||
|
|
destination window.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.putwin">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">putwin</code><span class="sig-paren">(</span><em>file</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.putwin" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Write all data associated with the window into the provided file object. This
|
|||
|
|
information can be later retrieved using the <a class="reference internal" href="#curses.getwin" title="curses.getwin"><code class="xref py py-func docutils literal notranslate"><span class="pre">getwin()</span></code></a> function.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.redrawln">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">redrawln</code><span class="sig-paren">(</span><em>beg</em>, <em>num</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.redrawln" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Indicate that the <em>num</em> screen lines, starting at line <em>beg</em>, are corrupted and
|
|||
|
|
should be completely redrawn on the next <a class="reference internal" href="#curses.window.refresh" title="curses.window.refresh"><code class="xref py py-meth docutils literal notranslate"><span class="pre">refresh()</span></code></a> call.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.redrawwin">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">redrawwin</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.redrawwin" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Touch the entire window, causing it to be completely redrawn on the next
|
|||
|
|
<a class="reference internal" href="#curses.window.refresh" title="curses.window.refresh"><code class="xref py py-meth docutils literal notranslate"><span class="pre">refresh()</span></code></a> call.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.refresh">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">refresh</code><span class="sig-paren">(</span><span class="optional">[</span><em>pminrow</em>, <em>pmincol</em>, <em>sminrow</em>, <em>smincol</em>, <em>smaxrow</em>, <em>smaxcol</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.refresh" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Update the display immediately (sync actual screen with previous
|
|||
|
|
drawing/deleting methods).</p>
|
|||
|
|
<p>The 6 optional arguments can only be specified when the window is a pad created
|
|||
|
|
with <a class="reference internal" href="#curses.newpad" title="curses.newpad"><code class="xref py py-func docutils literal notranslate"><span class="pre">newpad()</span></code></a>. The additional parameters are needed to indicate what part
|
|||
|
|
of the pad and screen are involved. <em>pminrow</em> and <em>pmincol</em> specify the upper
|
|||
|
|
left-hand corner of the rectangle to be displayed in the pad. <em>sminrow</em>,
|
|||
|
|
<em>smincol</em>, <em>smaxrow</em>, and <em>smaxcol</em> specify the edges of the rectangle to be
|
|||
|
|
displayed on the screen. The lower right-hand corner of the rectangle to be
|
|||
|
|
displayed in the pad is calculated from the screen coordinates, since the
|
|||
|
|
rectangles must be the same size. Both rectangles must be entirely contained
|
|||
|
|
within their respective structures. Negative values of <em>pminrow</em>, <em>pmincol</em>,
|
|||
|
|
<em>sminrow</em>, or <em>smincol</em> are treated as if they were zero.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.resize">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">resize</code><span class="sig-paren">(</span><em>nlines</em>, <em>ncols</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.resize" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Reallocate storage for a curses window to adjust its dimensions to the
|
|||
|
|
specified values. If either dimension is larger than the current values, the
|
|||
|
|
window’s data is filled with blanks that have the current background
|
|||
|
|
rendition (as set by <a class="reference internal" href="#curses.window.bkgdset" title="curses.window.bkgdset"><code class="xref py py-meth docutils literal notranslate"><span class="pre">bkgdset()</span></code></a>) merged into them.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.scroll">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">scroll</code><span class="sig-paren">(</span><span class="optional">[</span><em>lines=1</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.scroll" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Scroll the screen or scrolling region upward by <em>lines</em> lines.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.scrollok">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">scrollok</code><span class="sig-paren">(</span><em>flag</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.scrollok" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Control what happens when the cursor of a window is moved off the edge of the
|
|||
|
|
window or scrolling region, either as a result of a newline action on the bottom
|
|||
|
|
line, or typing the last character of the last line. If <em>flag</em> is <code class="docutils literal notranslate"><span class="pre">False</span></code>, the
|
|||
|
|
cursor is left on the bottom line. If <em>flag</em> is <code class="docutils literal notranslate"><span class="pre">True</span></code>, the window is scrolled up
|
|||
|
|
one line. Note that in order to get the physical scrolling effect on the
|
|||
|
|
terminal, it is also necessary to call <a class="reference internal" href="#curses.window.idlok" title="curses.window.idlok"><code class="xref py py-meth docutils literal notranslate"><span class="pre">idlok()</span></code></a>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.setscrreg">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">setscrreg</code><span class="sig-paren">(</span><em>top</em>, <em>bottom</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.setscrreg" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Set the scrolling region from line <em>top</em> to line <em>bottom</em>. All scrolling actions
|
|||
|
|
will take place in this region.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.standend">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">standend</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.standend" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Turn off the standout attribute. On some terminals this has the side effect of
|
|||
|
|
turning off all attributes.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.standout">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">standout</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.standout" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Turn on attribute <em>A_STANDOUT</em>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.subpad">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">subpad</code><span class="sig-paren">(</span><em>begin_y</em>, <em>begin_x</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.subpad" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dt>
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">subpad</code><span class="sig-paren">(</span><em>nlines</em>, <em>ncols</em>, <em>begin_y</em>, <em>begin_x</em><span class="sig-paren">)</span></dt>
|
|||
|
|
<dd><p>Return a sub-window, whose upper-left corner is at <code class="docutils literal notranslate"><span class="pre">(begin_y,</span> <span class="pre">begin_x)</span></code>, and
|
|||
|
|
whose width/height is <em>ncols</em>/<em>nlines</em>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.subwin">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">subwin</code><span class="sig-paren">(</span><em>begin_y</em>, <em>begin_x</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.subwin" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dt>
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">subwin</code><span class="sig-paren">(</span><em>nlines</em>, <em>ncols</em>, <em>begin_y</em>, <em>begin_x</em><span class="sig-paren">)</span></dt>
|
|||
|
|
<dd><p>Return a sub-window, whose upper-left corner is at <code class="docutils literal notranslate"><span class="pre">(begin_y,</span> <span class="pre">begin_x)</span></code>, and
|
|||
|
|
whose width/height is <em>ncols</em>/<em>nlines</em>.</p>
|
|||
|
|
<p>By default, the sub-window will extend from the specified position to the lower
|
|||
|
|
right corner of the window.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.syncdown">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">syncdown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.syncdown" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Touch each location in the window that has been touched in any of its ancestor
|
|||
|
|
windows. This routine is called by <a class="reference internal" href="#curses.window.refresh" title="curses.window.refresh"><code class="xref py py-meth docutils literal notranslate"><span class="pre">refresh()</span></code></a>, so it should almost never
|
|||
|
|
be necessary to call it manually.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.syncok">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">syncok</code><span class="sig-paren">(</span><em>flag</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.syncok" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>If <em>flag</em> is <code class="docutils literal notranslate"><span class="pre">True</span></code>, then <a class="reference internal" href="#curses.window.syncup" title="curses.window.syncup"><code class="xref py py-meth docutils literal notranslate"><span class="pre">syncup()</span></code></a> is called automatically
|
|||
|
|
whenever there is a change in the window.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.syncup">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">syncup</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.syncup" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Touch all locations in ancestors of the window that have been changed in the
|
|||
|
|
window.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.timeout">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">timeout</code><span class="sig-paren">(</span><em>delay</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.timeout" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Set blocking or non-blocking read behavior for the window. If <em>delay</em> is
|
|||
|
|
negative, blocking read is used (which will wait indefinitely for input). If
|
|||
|
|
<em>delay</em> is zero, then non-blocking read is used, and <a class="reference internal" href="#curses.window.getch" title="curses.window.getch"><code class="xref py py-meth docutils literal notranslate"><span class="pre">getch()</span></code></a> will
|
|||
|
|
return <code class="docutils literal notranslate"><span class="pre">-1</span></code> if no input is waiting. If <em>delay</em> is positive, then
|
|||
|
|
<a class="reference internal" href="#curses.window.getch" title="curses.window.getch"><code class="xref py py-meth docutils literal notranslate"><span class="pre">getch()</span></code></a> will block for <em>delay</em> milliseconds, and return <code class="docutils literal notranslate"><span class="pre">-1</span></code> if there is
|
|||
|
|
still no input at the end of that time.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.touchline">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">touchline</code><span class="sig-paren">(</span><em>start</em>, <em>count</em><span class="optional">[</span>, <em>changed</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.touchline" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Pretend <em>count</em> lines have been changed, starting with line <em>start</em>. If
|
|||
|
|
<em>changed</em> is supplied, it specifies whether the affected lines are marked as
|
|||
|
|
having been changed (<em>changed</em><code class="docutils literal notranslate"><span class="pre">=True</span></code>) or unchanged (<em>changed</em><code class="docutils literal notranslate"><span class="pre">=False</span></code>).</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.touchwin">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">touchwin</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.touchwin" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Pretend the whole window has been changed, for purposes of drawing
|
|||
|
|
optimizations.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.untouchwin">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">untouchwin</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.untouchwin" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Mark all lines in the window as unchanged since the last call to
|
|||
|
|
<a class="reference internal" href="#curses.window.refresh" title="curses.window.refresh"><code class="xref py py-meth docutils literal notranslate"><span class="pre">refresh()</span></code></a>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.window.vline">
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">vline</code><span class="sig-paren">(</span><em>ch</em>, <em>n</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.vline" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dt>
|
|||
|
|
<code class="descclassname">window.</code><code class="descname">vline</code><span class="sig-paren">(</span><em>y</em>, <em>x</em>, <em>ch</em>, <em>n</em><span class="sig-paren">)</span></dt>
|
|||
|
|
<dd><p>Display a vertical line starting at <code class="docutils literal notranslate"><span class="pre">(y,</span> <span class="pre">x)</span></code> with length <em>n</em> consisting of the
|
|||
|
|
character <em>ch</em>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="constants">
|
|||
|
|
<h2>Constants<a class="headerlink" href="#constants" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The <a class="reference internal" href="#module-curses" title="curses: An interface to the curses library, providing portable terminal handling. (Unix)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">curses</span></code></a> module defines the following data members:</p>
|
|||
|
|
<dl class="data">
|
|||
|
|
<dt id="curses.ERR">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">ERR</code><a class="headerlink" href="#curses.ERR" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Some curses routines that return an integer, such as <code class="xref py py-func docutils literal notranslate"><span class="pre">getch()</span></code>, return
|
|||
|
|
<a class="reference internal" href="#curses.ERR" title="curses.ERR"><code class="xref py py-const docutils literal notranslate"><span class="pre">ERR</span></code></a> upon failure.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="data">
|
|||
|
|
<dt id="curses.OK">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">OK</code><a class="headerlink" href="#curses.OK" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Some curses routines that return an integer, such as <a class="reference internal" href="#curses.napms" title="curses.napms"><code class="xref py py-func docutils literal notranslate"><span class="pre">napms()</span></code></a>, return
|
|||
|
|
<a class="reference internal" href="#curses.OK" title="curses.OK"><code class="xref py py-const docutils literal notranslate"><span class="pre">OK</span></code></a> upon success.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="data">
|
|||
|
|
<dt id="curses.version">
|
|||
|
|
<code class="descclassname">curses.</code><code class="descname">version</code><a class="headerlink" href="#curses.version" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>A bytes object representing the current version of the module. Also available as
|
|||
|
|
<code class="xref py py-const docutils literal notranslate"><span class="pre">__version__</span></code>.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<p>Some constants are available to specify character cell attributes.
|
|||
|
|
The exact constants available are system dependent.</p>
|
|||
|
|
<table class="docutils align-center">
|
|||
|
|
<colgroup>
|
|||
|
|
<col style="width: 37%" />
|
|||
|
|
<col style="width: 63%" />
|
|||
|
|
</colgroup>
|
|||
|
|
<thead>
|
|||
|
|
<tr class="row-odd"><th class="head"><p>Attribute</p></th>
|
|||
|
|
<th class="head"><p>Meaning</p></th>
|
|||
|
|
</tr>
|
|||
|
|
</thead>
|
|||
|
|
<tbody>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">A_ALTCHARSET</span></code></p></td>
|
|||
|
|
<td><p>Alternate character set mode</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">A_BLINK</span></code></p></td>
|
|||
|
|
<td><p>Blink mode</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">A_BOLD</span></code></p></td>
|
|||
|
|
<td><p>Bold mode</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">A_DIM</span></code></p></td>
|
|||
|
|
<td><p>Dim mode</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">A_INVIS</span></code></p></td>
|
|||
|
|
<td><p>Invisible or blank mode</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">A_ITALIC</span></code></p></td>
|
|||
|
|
<td><p>Italic mode</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">A_NORMAL</span></code></p></td>
|
|||
|
|
<td><p>Normal attribute</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">A_PROTECT</span></code></p></td>
|
|||
|
|
<td><p>Protected mode</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">A_REVERSE</span></code></p></td>
|
|||
|
|
<td><p>Reverse background and
|
|||
|
|
foreground colors</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">A_STANDOUT</span></code></p></td>
|
|||
|
|
<td><p>Standout mode</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">A_UNDERLINE</span></code></p></td>
|
|||
|
|
<td><p>Underline mode</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">A_HORIZONTAL</span></code></p></td>
|
|||
|
|
<td><p>Horizontal highlight</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">A_LEFT</span></code></p></td>
|
|||
|
|
<td><p>Left highlight</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">A_LOW</span></code></p></td>
|
|||
|
|
<td><p>Low highlight</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">A_RIGHT</span></code></p></td>
|
|||
|
|
<td><p>Right highlight</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">A_TOP</span></code></p></td>
|
|||
|
|
<td><p>Top highlight</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">A_VERTICAL</span></code></p></td>
|
|||
|
|
<td><p>Vertical highlight</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">A_CHARTEXT</span></code></p></td>
|
|||
|
|
<td><p>Bit-mask to extract a
|
|||
|
|
character</p></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
<div class="versionadded">
|
|||
|
|
<p><span class="versionmodified added">New in version 3.7: </span><code class="docutils literal notranslate"><span class="pre">A_ITALIC</span></code> was added.</p>
|
|||
|
|
</div>
|
|||
|
|
<p>Several constants are available to extract corresponding attributes returned
|
|||
|
|
by some methods.</p>
|
|||
|
|
<table class="docutils align-center">
|
|||
|
|
<colgroup>
|
|||
|
|
<col style="width: 37%" />
|
|||
|
|
<col style="width: 63%" />
|
|||
|
|
</colgroup>
|
|||
|
|
<thead>
|
|||
|
|
<tr class="row-odd"><th class="head"><p>Bit-mask</p></th>
|
|||
|
|
<th class="head"><p>Meaning</p></th>
|
|||
|
|
</tr>
|
|||
|
|
</thead>
|
|||
|
|
<tbody>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">A_ATTRIBUTES</span></code></p></td>
|
|||
|
|
<td><p>Bit-mask to extract
|
|||
|
|
attributes</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">A_CHARTEXT</span></code></p></td>
|
|||
|
|
<td><p>Bit-mask to extract a
|
|||
|
|
character</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">A_COLOR</span></code></p></td>
|
|||
|
|
<td><p>Bit-mask to extract
|
|||
|
|
color-pair field information</p></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
<p>Keys are referred to by integer constants with names starting with <code class="docutils literal notranslate"><span class="pre">KEY_</span></code>.
|
|||
|
|
The exact keycaps available are system dependent.</p>
|
|||
|
|
<table class="docutils align-center">
|
|||
|
|
<colgroup>
|
|||
|
|
<col style="width: 30%" />
|
|||
|
|
<col style="width: 70%" />
|
|||
|
|
</colgroup>
|
|||
|
|
<thead>
|
|||
|
|
<tr class="row-odd"><th class="head"><p>Key constant</p></th>
|
|||
|
|
<th class="head"><p>Key</p></th>
|
|||
|
|
</tr>
|
|||
|
|
</thead>
|
|||
|
|
<tbody>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_MIN</span></code></p></td>
|
|||
|
|
<td><p>Minimum key value</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_BREAK</span></code></p></td>
|
|||
|
|
<td><p>Break key (unreliable)</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_DOWN</span></code></p></td>
|
|||
|
|
<td><p>Down-arrow</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_UP</span></code></p></td>
|
|||
|
|
<td><p>Up-arrow</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_LEFT</span></code></p></td>
|
|||
|
|
<td><p>Left-arrow</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_RIGHT</span></code></p></td>
|
|||
|
|
<td><p>Right-arrow</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_HOME</span></code></p></td>
|
|||
|
|
<td><p>Home key (upward+left arrow)</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_BACKSPACE</span></code></p></td>
|
|||
|
|
<td><p>Backspace (unreliable)</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_F0</span></code></p></td>
|
|||
|
|
<td><p>Function keys. Up to 64 function keys are
|
|||
|
|
supported.</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_Fn</span></code></p></td>
|
|||
|
|
<td><p>Value of function key <em>n</em></p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_DL</span></code></p></td>
|
|||
|
|
<td><p>Delete line</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_IL</span></code></p></td>
|
|||
|
|
<td><p>Insert line</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_DC</span></code></p></td>
|
|||
|
|
<td><p>Delete character</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_IC</span></code></p></td>
|
|||
|
|
<td><p>Insert char or enter insert mode</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_EIC</span></code></p></td>
|
|||
|
|
<td><p>Exit insert char mode</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_CLEAR</span></code></p></td>
|
|||
|
|
<td><p>Clear screen</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_EOS</span></code></p></td>
|
|||
|
|
<td><p>Clear to end of screen</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_EOL</span></code></p></td>
|
|||
|
|
<td><p>Clear to end of line</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SF</span></code></p></td>
|
|||
|
|
<td><p>Scroll 1 line forward</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SR</span></code></p></td>
|
|||
|
|
<td><p>Scroll 1 line backward (reverse)</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_NPAGE</span></code></p></td>
|
|||
|
|
<td><p>Next page</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_PPAGE</span></code></p></td>
|
|||
|
|
<td><p>Previous page</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_STAB</span></code></p></td>
|
|||
|
|
<td><p>Set tab</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_CTAB</span></code></p></td>
|
|||
|
|
<td><p>Clear tab</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_CATAB</span></code></p></td>
|
|||
|
|
<td><p>Clear all tabs</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_ENTER</span></code></p></td>
|
|||
|
|
<td><p>Enter or send (unreliable)</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SRESET</span></code></p></td>
|
|||
|
|
<td><p>Soft (partial) reset (unreliable)</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_RESET</span></code></p></td>
|
|||
|
|
<td><p>Reset or hard reset (unreliable)</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_PRINT</span></code></p></td>
|
|||
|
|
<td><p>Print</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_LL</span></code></p></td>
|
|||
|
|
<td><p>Home down or bottom (lower left)</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_A1</span></code></p></td>
|
|||
|
|
<td><p>Upper left of keypad</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_A3</span></code></p></td>
|
|||
|
|
<td><p>Upper right of keypad</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_B2</span></code></p></td>
|
|||
|
|
<td><p>Center of keypad</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_C1</span></code></p></td>
|
|||
|
|
<td><p>Lower left of keypad</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_C3</span></code></p></td>
|
|||
|
|
<td><p>Lower right of keypad</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_BTAB</span></code></p></td>
|
|||
|
|
<td><p>Back tab</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_BEG</span></code></p></td>
|
|||
|
|
<td><p>Beg (beginning)</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_CANCEL</span></code></p></td>
|
|||
|
|
<td><p>Cancel</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_CLOSE</span></code></p></td>
|
|||
|
|
<td><p>Close</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_COMMAND</span></code></p></td>
|
|||
|
|
<td><p>Cmd (command)</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_COPY</span></code></p></td>
|
|||
|
|
<td><p>Copy</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_CREATE</span></code></p></td>
|
|||
|
|
<td><p>Create</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_END</span></code></p></td>
|
|||
|
|
<td><p>End</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_EXIT</span></code></p></td>
|
|||
|
|
<td><p>Exit</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_FIND</span></code></p></td>
|
|||
|
|
<td><p>Find</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_HELP</span></code></p></td>
|
|||
|
|
<td><p>Help</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_MARK</span></code></p></td>
|
|||
|
|
<td><p>Mark</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_MESSAGE</span></code></p></td>
|
|||
|
|
<td><p>Message</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_MOVE</span></code></p></td>
|
|||
|
|
<td><p>Move</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_NEXT</span></code></p></td>
|
|||
|
|
<td><p>Next</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_OPEN</span></code></p></td>
|
|||
|
|
<td><p>Open</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_OPTIONS</span></code></p></td>
|
|||
|
|
<td><p>Options</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_PREVIOUS</span></code></p></td>
|
|||
|
|
<td><p>Prev (previous)</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_REDO</span></code></p></td>
|
|||
|
|
<td><p>Redo</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_REFERENCE</span></code></p></td>
|
|||
|
|
<td><p>Ref (reference)</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_REFRESH</span></code></p></td>
|
|||
|
|
<td><p>Refresh</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_REPLACE</span></code></p></td>
|
|||
|
|
<td><p>Replace</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_RESTART</span></code></p></td>
|
|||
|
|
<td><p>Restart</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_RESUME</span></code></p></td>
|
|||
|
|
<td><p>Resume</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SAVE</span></code></p></td>
|
|||
|
|
<td><p>Save</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SBEG</span></code></p></td>
|
|||
|
|
<td><p>Shifted Beg (beginning)</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SCANCEL</span></code></p></td>
|
|||
|
|
<td><p>Shifted Cancel</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SCOMMAND</span></code></p></td>
|
|||
|
|
<td><p>Shifted Command</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SCOPY</span></code></p></td>
|
|||
|
|
<td><p>Shifted Copy</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SCREATE</span></code></p></td>
|
|||
|
|
<td><p>Shifted Create</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SDC</span></code></p></td>
|
|||
|
|
<td><p>Shifted Delete char</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SDL</span></code></p></td>
|
|||
|
|
<td><p>Shifted Delete line</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SELECT</span></code></p></td>
|
|||
|
|
<td><p>Select</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SEND</span></code></p></td>
|
|||
|
|
<td><p>Shifted End</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SEOL</span></code></p></td>
|
|||
|
|
<td><p>Shifted Clear line</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SEXIT</span></code></p></td>
|
|||
|
|
<td><p>Shifted Exit</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SFIND</span></code></p></td>
|
|||
|
|
<td><p>Shifted Find</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SHELP</span></code></p></td>
|
|||
|
|
<td><p>Shifted Help</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SHOME</span></code></p></td>
|
|||
|
|
<td><p>Shifted Home</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SIC</span></code></p></td>
|
|||
|
|
<td><p>Shifted Input</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SLEFT</span></code></p></td>
|
|||
|
|
<td><p>Shifted Left arrow</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SMESSAGE</span></code></p></td>
|
|||
|
|
<td><p>Shifted Message</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SMOVE</span></code></p></td>
|
|||
|
|
<td><p>Shifted Move</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SNEXT</span></code></p></td>
|
|||
|
|
<td><p>Shifted Next</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SOPTIONS</span></code></p></td>
|
|||
|
|
<td><p>Shifted Options</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SPREVIOUS</span></code></p></td>
|
|||
|
|
<td><p>Shifted Prev</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SPRINT</span></code></p></td>
|
|||
|
|
<td><p>Shifted Print</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SREDO</span></code></p></td>
|
|||
|
|
<td><p>Shifted Redo</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SREPLACE</span></code></p></td>
|
|||
|
|
<td><p>Shifted Replace</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SRIGHT</span></code></p></td>
|
|||
|
|
<td><p>Shifted Right arrow</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SRSUME</span></code></p></td>
|
|||
|
|
<td><p>Shifted Resume</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SSAVE</span></code></p></td>
|
|||
|
|
<td><p>Shifted Save</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SSUSPEND</span></code></p></td>
|
|||
|
|
<td><p>Shifted Suspend</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SUNDO</span></code></p></td>
|
|||
|
|
<td><p>Shifted Undo</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_SUSPEND</span></code></p></td>
|
|||
|
|
<td><p>Suspend</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_UNDO</span></code></p></td>
|
|||
|
|
<td><p>Undo</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_MOUSE</span></code></p></td>
|
|||
|
|
<td><p>Mouse event has occurred</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_RESIZE</span></code></p></td>
|
|||
|
|
<td><p>Terminal resize event</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">KEY_MAX</span></code></p></td>
|
|||
|
|
<td><p>Maximum key value</p></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
<p>On VT100s and their software emulations, such as X terminal emulators, there are
|
|||
|
|
normally at least four function keys (<code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_F1</span></code>, <code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_F2</span></code>,
|
|||
|
|
<code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_F3</span></code>, <code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_F4</span></code>) available, and the arrow keys mapped to
|
|||
|
|
<code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_UP</span></code>, <code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_DOWN</span></code>, <code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_LEFT</span></code> and <code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_RIGHT</span></code> in
|
|||
|
|
the obvious way. If your machine has a PC keyboard, it is safe to expect arrow
|
|||
|
|
keys and twelve function keys (older PC keyboards may have only ten function
|
|||
|
|
keys); also, the following keypad mappings are standard:</p>
|
|||
|
|
<table class="docutils align-center">
|
|||
|
|
<colgroup>
|
|||
|
|
<col style="width: 62%" />
|
|||
|
|
<col style="width: 38%" />
|
|||
|
|
</colgroup>
|
|||
|
|
<thead>
|
|||
|
|
<tr class="row-odd"><th class="head"><p>Keycap</p></th>
|
|||
|
|
<th class="head"><p>Constant</p></th>
|
|||
|
|
</tr>
|
|||
|
|
</thead>
|
|||
|
|
<tbody>
|
|||
|
|
<tr class="row-even"><td><p><kbd class="kbd docutils literal notranslate">Insert</kbd></p></td>
|
|||
|
|
<td><p>KEY_IC</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><kbd class="kbd docutils literal notranslate">Delete</kbd></p></td>
|
|||
|
|
<td><p>KEY_DC</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><kbd class="kbd docutils literal notranslate">Home</kbd></p></td>
|
|||
|
|
<td><p>KEY_HOME</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><kbd class="kbd docutils literal notranslate">End</kbd></p></td>
|
|||
|
|
<td><p>KEY_END</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><kbd class="kbd docutils literal notranslate">Page Up</kbd></p></td>
|
|||
|
|
<td><p>KEY_PPAGE</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><kbd class="kbd docutils literal notranslate">Page Down</kbd></p></td>
|
|||
|
|
<td><p>KEY_NPAGE</p></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
<p>The following table lists characters from the alternate character set. These are
|
|||
|
|
inherited from the VT100 terminal, and will generally be available on software
|
|||
|
|
emulations such as X terminals. When there is no graphic available, curses
|
|||
|
|
falls back on a crude printable ASCII approximation.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>These are available only after <a class="reference internal" href="#curses.initscr" title="curses.initscr"><code class="xref py py-func docutils literal notranslate"><span class="pre">initscr()</span></code></a> has been called.</p>
|
|||
|
|
</div>
|
|||
|
|
<table class="docutils align-center">
|
|||
|
|
<colgroup>
|
|||
|
|
<col style="width: 30%" />
|
|||
|
|
<col style="width: 70%" />
|
|||
|
|
</colgroup>
|
|||
|
|
<thead>
|
|||
|
|
<tr class="row-odd"><th class="head"><p>ACS code</p></th>
|
|||
|
|
<th class="head"><p>Meaning</p></th>
|
|||
|
|
</tr>
|
|||
|
|
</thead>
|
|||
|
|
<tbody>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_BBSS</span></code></p></td>
|
|||
|
|
<td><p>alternate name for upper right corner</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_BLOCK</span></code></p></td>
|
|||
|
|
<td><p>solid square block</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_BOARD</span></code></p></td>
|
|||
|
|
<td><p>board of squares</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_BSBS</span></code></p></td>
|
|||
|
|
<td><p>alternate name for horizontal line</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_BSSB</span></code></p></td>
|
|||
|
|
<td><p>alternate name for upper left corner</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_BSSS</span></code></p></td>
|
|||
|
|
<td><p>alternate name for top tee</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_BTEE</span></code></p></td>
|
|||
|
|
<td><p>bottom tee</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_BULLET</span></code></p></td>
|
|||
|
|
<td><p>bullet</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_CKBOARD</span></code></p></td>
|
|||
|
|
<td><p>checker board (stipple)</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_DARROW</span></code></p></td>
|
|||
|
|
<td><p>arrow pointing down</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_DEGREE</span></code></p></td>
|
|||
|
|
<td><p>degree symbol</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_DIAMOND</span></code></p></td>
|
|||
|
|
<td><p>diamond</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_GEQUAL</span></code></p></td>
|
|||
|
|
<td><p>greater-than-or-equal-to</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_HLINE</span></code></p></td>
|
|||
|
|
<td><p>horizontal line</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_LANTERN</span></code></p></td>
|
|||
|
|
<td><p>lantern symbol</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_LARROW</span></code></p></td>
|
|||
|
|
<td><p>left arrow</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_LEQUAL</span></code></p></td>
|
|||
|
|
<td><p>less-than-or-equal-to</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_LLCORNER</span></code></p></td>
|
|||
|
|
<td><p>lower left-hand corner</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_LRCORNER</span></code></p></td>
|
|||
|
|
<td><p>lower right-hand corner</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_LTEE</span></code></p></td>
|
|||
|
|
<td><p>left tee</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_NEQUAL</span></code></p></td>
|
|||
|
|
<td><p>not-equal sign</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_PI</span></code></p></td>
|
|||
|
|
<td><p>letter pi</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_PLMINUS</span></code></p></td>
|
|||
|
|
<td><p>plus-or-minus sign</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_PLUS</span></code></p></td>
|
|||
|
|
<td><p>big plus sign</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_RARROW</span></code></p></td>
|
|||
|
|
<td><p>right arrow</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_RTEE</span></code></p></td>
|
|||
|
|
<td><p>right tee</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_S1</span></code></p></td>
|
|||
|
|
<td><p>scan line 1</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_S3</span></code></p></td>
|
|||
|
|
<td><p>scan line 3</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_S7</span></code></p></td>
|
|||
|
|
<td><p>scan line 7</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_S9</span></code></p></td>
|
|||
|
|
<td><p>scan line 9</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_SBBS</span></code></p></td>
|
|||
|
|
<td><p>alternate name for lower right corner</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_SBSB</span></code></p></td>
|
|||
|
|
<td><p>alternate name for vertical line</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_SBSS</span></code></p></td>
|
|||
|
|
<td><p>alternate name for right tee</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_SSBB</span></code></p></td>
|
|||
|
|
<td><p>alternate name for lower left corner</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_SSBS</span></code></p></td>
|
|||
|
|
<td><p>alternate name for bottom tee</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_SSSB</span></code></p></td>
|
|||
|
|
<td><p>alternate name for left tee</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_SSSS</span></code></p></td>
|
|||
|
|
<td><p>alternate name for crossover or big plus</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_STERLING</span></code></p></td>
|
|||
|
|
<td><p>pound sterling</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_TTEE</span></code></p></td>
|
|||
|
|
<td><p>top tee</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_UARROW</span></code></p></td>
|
|||
|
|
<td><p>up arrow</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_ULCORNER</span></code></p></td>
|
|||
|
|
<td><p>upper left corner</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_URCORNER</span></code></p></td>
|
|||
|
|
<td><p>upper right corner</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ACS_VLINE</span></code></p></td>
|
|||
|
|
<td><p>vertical line</p></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
<p>The following table lists the predefined colors:</p>
|
|||
|
|
<table class="docutils align-center">
|
|||
|
|
<colgroup>
|
|||
|
|
<col style="width: 40%" />
|
|||
|
|
<col style="width: 60%" />
|
|||
|
|
</colgroup>
|
|||
|
|
<thead>
|
|||
|
|
<tr class="row-odd"><th class="head"><p>Constant</p></th>
|
|||
|
|
<th class="head"><p>Color</p></th>
|
|||
|
|
</tr>
|
|||
|
|
</thead>
|
|||
|
|
<tbody>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">COLOR_BLACK</span></code></p></td>
|
|||
|
|
<td><p>Black</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">COLOR_BLUE</span></code></p></td>
|
|||
|
|
<td><p>Blue</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">COLOR_CYAN</span></code></p></td>
|
|||
|
|
<td><p>Cyan (light greenish blue)</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">COLOR_GREEN</span></code></p></td>
|
|||
|
|
<td><p>Green</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">COLOR_MAGENTA</span></code></p></td>
|
|||
|
|
<td><p>Magenta (purplish red)</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">COLOR_RED</span></code></p></td>
|
|||
|
|
<td><p>Red</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">COLOR_WHITE</span></code></p></td>
|
|||
|
|
<td><p>White</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">COLOR_YELLOW</span></code></p></td>
|
|||
|
|
<td><p>Yellow</p></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-curses.textpad">
|
|||
|
|
<span id="curses-textpad-text-input-widget-for-curses-programs"></span><h1><a class="reference internal" href="#module-curses.textpad" title="curses.textpad: Emacs-like input editing in a curses window."><code class="xref py py-mod docutils literal notranslate"><span class="pre">curses.textpad</span></code></a> — Text input widget for curses programs<a class="headerlink" href="#module-curses.textpad" title="Permalink to this headline">¶</a></h1>
|
|||
|
|
<p>The <a class="reference internal" href="#module-curses.textpad" title="curses.textpad: Emacs-like input editing in a curses window."><code class="xref py py-mod docutils literal notranslate"><span class="pre">curses.textpad</span></code></a> module provides a <a class="reference internal" href="#curses.textpad.Textbox" title="curses.textpad.Textbox"><code class="xref py py-class docutils literal notranslate"><span class="pre">Textbox</span></code></a> class that handles
|
|||
|
|
elementary text editing in a curses window, supporting a set of keybindings
|
|||
|
|
resembling those of Emacs (thus, also of Netscape Navigator, BBedit 6.x,
|
|||
|
|
FrameMaker, and many other programs). The module also provides a
|
|||
|
|
rectangle-drawing function useful for framing text boxes or for other purposes.</p>
|
|||
|
|
<p>The module <a class="reference internal" href="#module-curses.textpad" title="curses.textpad: Emacs-like input editing in a curses window."><code class="xref py py-mod docutils literal notranslate"><span class="pre">curses.textpad</span></code></a> defines the following function:</p>
|
|||
|
|
<dl class="function">
|
|||
|
|
<dt id="curses.textpad.rectangle">
|
|||
|
|
<code class="descclassname">curses.textpad.</code><code class="descname">rectangle</code><span class="sig-paren">(</span><em>win</em>, <em>uly</em>, <em>ulx</em>, <em>lry</em>, <em>lrx</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.textpad.rectangle" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Draw a rectangle. The first argument must be a window object; the remaining
|
|||
|
|
arguments are coordinates relative to that window. The second and third
|
|||
|
|
arguments are the y and x coordinates of the upper left hand corner of the
|
|||
|
|
rectangle to be drawn; the fourth and fifth arguments are the y and x
|
|||
|
|
coordinates of the lower right hand corner. The rectangle will be drawn using
|
|||
|
|
VT100/IBM PC forms characters on terminals that make this possible (including
|
|||
|
|
xterm and most other software terminal emulators). Otherwise it will be drawn
|
|||
|
|
with ASCII dashes, vertical bars, and plus signs.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<div class="section" id="textbox-objects">
|
|||
|
|
<span id="curses-textpad-objects"></span><h2>Textbox objects<a class="headerlink" href="#textbox-objects" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>You can instantiate a <a class="reference internal" href="#curses.textpad.Textbox" title="curses.textpad.Textbox"><code class="xref py py-class docutils literal notranslate"><span class="pre">Textbox</span></code></a> object as follows:</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="curses.textpad.Textbox">
|
|||
|
|
<em class="property">class </em><code class="descclassname">curses.textpad.</code><code class="descname">Textbox</code><span class="sig-paren">(</span><em>win</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.textpad.Textbox" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return a textbox widget object. The <em>win</em> argument should be a curses
|
|||
|
|
<a class="reference internal" href="#curses-window-objects"><span class="std std-ref">window</span></a> object in which the textbox is to
|
|||
|
|
be contained. The edit cursor of the textbox is initially located at the
|
|||
|
|
upper left hand corner of the containing window, with coordinates <code class="docutils literal notranslate"><span class="pre">(0,</span> <span class="pre">0)</span></code>.
|
|||
|
|
The instance’s <a class="reference internal" href="#curses.textpad.Textbox.stripspaces" title="curses.textpad.Textbox.stripspaces"><code class="xref py py-attr docutils literal notranslate"><span class="pre">stripspaces</span></code></a> flag is initially on.</p>
|
|||
|
|
<p><a class="reference internal" href="#curses.textpad.Textbox" title="curses.textpad.Textbox"><code class="xref py py-class docutils literal notranslate"><span class="pre">Textbox</span></code></a> objects have the following methods:</p>
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.textpad.Textbox.edit">
|
|||
|
|
<code class="descname">edit</code><span class="sig-paren">(</span><span class="optional">[</span><em>validator</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.textpad.Textbox.edit" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>This is the entry point you will normally use. It accepts editing
|
|||
|
|
keystrokes until one of the termination keystrokes is entered. If
|
|||
|
|
<em>validator</em> is supplied, it must be a function. It will be called for
|
|||
|
|
each keystroke entered with the keystroke as a parameter; command dispatch
|
|||
|
|
is done on the result. This method returns the window contents as a
|
|||
|
|
string; whether blanks in the window are included is affected by the
|
|||
|
|
<a class="reference internal" href="#curses.textpad.Textbox.stripspaces" title="curses.textpad.Textbox.stripspaces"><code class="xref py py-attr docutils literal notranslate"><span class="pre">stripspaces</span></code></a> attribute.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.textpad.Textbox.do_command">
|
|||
|
|
<code class="descname">do_command</code><span class="sig-paren">(</span><em>ch</em><span class="sig-paren">)</span><a class="headerlink" href="#curses.textpad.Textbox.do_command" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Process a single command keystroke. Here are the supported special
|
|||
|
|
keystrokes:</p>
|
|||
|
|
<table class="docutils align-center">
|
|||
|
|
<colgroup>
|
|||
|
|
<col style="width: 30%" />
|
|||
|
|
<col style="width: 70%" />
|
|||
|
|
</colgroup>
|
|||
|
|
<thead>
|
|||
|
|
<tr class="row-odd"><th class="head"><p>Keystroke</p></th>
|
|||
|
|
<th class="head"><p>Action</p></th>
|
|||
|
|
</tr>
|
|||
|
|
</thead>
|
|||
|
|
<tbody>
|
|||
|
|
<tr class="row-even"><td><p><kbd class="kbd docutils literal notranslate">Control-A</kbd></p></td>
|
|||
|
|
<td><p>Go to left edge of window.</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><kbd class="kbd docutils literal notranslate">Control-B</kbd></p></td>
|
|||
|
|
<td><p>Cursor left, wrapping to previous line if
|
|||
|
|
appropriate.</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><kbd class="kbd docutils literal notranslate">Control-D</kbd></p></td>
|
|||
|
|
<td><p>Delete character under cursor.</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><kbd class="kbd docutils literal notranslate">Control-E</kbd></p></td>
|
|||
|
|
<td><p>Go to right edge (stripspaces off) or end
|
|||
|
|
of line (stripspaces on).</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><kbd class="kbd docutils literal notranslate">Control-F</kbd></p></td>
|
|||
|
|
<td><p>Cursor right, wrapping to next line when
|
|||
|
|
appropriate.</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><kbd class="kbd docutils literal notranslate">Control-G</kbd></p></td>
|
|||
|
|
<td><p>Terminate, returning the window contents.</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><kbd class="kbd docutils literal notranslate">Control-H</kbd></p></td>
|
|||
|
|
<td><p>Delete character backward.</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><kbd class="kbd docutils literal notranslate">Control-J</kbd></p></td>
|
|||
|
|
<td><p>Terminate if the window is 1 line,
|
|||
|
|
otherwise insert newline.</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><kbd class="kbd docutils literal notranslate">Control-K</kbd></p></td>
|
|||
|
|
<td><p>If line is blank, delete it, otherwise
|
|||
|
|
clear to end of line.</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><kbd class="kbd docutils literal notranslate">Control-L</kbd></p></td>
|
|||
|
|
<td><p>Refresh screen.</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><kbd class="kbd docutils literal notranslate">Control-N</kbd></p></td>
|
|||
|
|
<td><p>Cursor down; move down one line.</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><kbd class="kbd docutils literal notranslate">Control-O</kbd></p></td>
|
|||
|
|
<td><p>Insert a blank line at cursor location.</p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><kbd class="kbd docutils literal notranslate">Control-P</kbd></p></td>
|
|||
|
|
<td><p>Cursor up; move up one line.</p></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
<p>Move operations do nothing if the cursor is at an edge where the movement
|
|||
|
|
is not possible. The following synonyms are supported where possible:</p>
|
|||
|
|
<table class="docutils align-center">
|
|||
|
|
<colgroup>
|
|||
|
|
<col style="width: 57%" />
|
|||
|
|
<col style="width: 43%" />
|
|||
|
|
</colgroup>
|
|||
|
|
<thead>
|
|||
|
|
<tr class="row-odd"><th class="head"><p>Constant</p></th>
|
|||
|
|
<th class="head"><p>Keystroke</p></th>
|
|||
|
|
</tr>
|
|||
|
|
</thead>
|
|||
|
|
<tbody>
|
|||
|
|
<tr class="row-even"><td><p><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_LEFT</span></code></p></td>
|
|||
|
|
<td><p><kbd class="kbd docutils literal notranslate">Control-B</kbd></p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_RIGHT</span></code></p></td>
|
|||
|
|
<td><p><kbd class="kbd docutils literal notranslate">Control-F</kbd></p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_UP</span></code></p></td>
|
|||
|
|
<td><p><kbd class="kbd docutils literal notranslate">Control-P</kbd></p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><p><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_DOWN</span></code></p></td>
|
|||
|
|
<td><p><kbd class="kbd docutils literal notranslate">Control-N</kbd></p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><p><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_BACKSPACE</span></code></p></td>
|
|||
|
|
<td><p><kbd class="kbd docutils literal notranslate">Control-h</kbd></p></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
<p>All other keystrokes are treated as a command to insert the given
|
|||
|
|
character and move right (with line wrapping).</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="curses.textpad.Textbox.gather">
|
|||
|
|
<code class="descname">gather</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.textpad.Textbox.gather" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Return the window contents as a string; whether blanks in the
|
|||
|
|
window are included is affected by the <a class="reference internal" href="#curses.textpad.Textbox.stripspaces" title="curses.textpad.Textbox.stripspaces"><code class="xref py py-attr docutils literal notranslate"><span class="pre">stripspaces</span></code></a> member.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="curses.textpad.Textbox.stripspaces">
|
|||
|
|
<code class="descname">stripspaces</code><a class="headerlink" href="#curses.textpad.Textbox.stripspaces" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>This attribute is a flag which controls the interpretation of blanks in
|
|||
|
|
the window. When it is on, trailing blanks on each line are ignored; any
|
|||
|
|
cursor motion that would land the cursor on a trailing blank goes to the
|
|||
|
|
end of that line instead, and trailing blanks are stripped when the window
|
|||
|
|
contents are gathered.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|||
|
|
<div class="sphinxsidebarwrapper">
|
|||
|
|
<h3><a href="../contents.html">Table of Contents</a></h3>
|
|||
|
|
<ul>
|
|||
|
|
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">curses</span></code> — Terminal handling for character-cell displays</a><ul>
|
|||
|
|
<li><a class="reference internal" href="#functions">Functions</a></li>
|
|||
|
|
<li><a class="reference internal" href="#window-objects">Window Objects</a></li>
|
|||
|
|
<li><a class="reference internal" href="#constants">Constants</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li><a class="reference internal" href="#module-curses.textpad"><code class="xref py py-mod docutils literal notranslate"><span class="pre">curses.textpad</span></code> — Text input widget for curses programs</a><ul>
|
|||
|
|
<li><a class="reference internal" href="#textbox-objects">Textbox objects</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
<h4>Previous topic</h4>
|
|||
|
|
<p class="topless"><a href="getpass.html"
|
|||
|
|
title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">getpass</span></code> — Portable password input</a></p>
|
|||
|
|
<h4>Next topic</h4>
|
|||
|
|
<p class="topless"><a href="curses.ascii.html"
|
|||
|
|
title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">curses.ascii</span></code> — Utilities for ASCII characters</a></p>
|
|||
|
|
<div role="note" aria-label="source link">
|
|||
|
|
<h3>This Page</h3>
|
|||
|
|
<ul class="this-page-menu">
|
|||
|
|
<li><a href="../bugs.html">Report a Bug</a></li>
|
|||
|
|
<li>
|
|||
|
|
<a href="https://github.com/python/cpython/blob/3.7/Doc/library/curses.rst"
|
|||
|
|
rel="nofollow">Show Source
|
|||
|
|
</a>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<div class="clearer"></div>
|
|||
|
|
</div>
|
|||
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|||
|
|
<h3>Navigation</h3>
|
|||
|
|
<ul>
|
|||
|
|
<li class="right" style="margin-right: 10px">
|
|||
|
|
<a href="../genindex.html" title="General Index"
|
|||
|
|
>index</a></li>
|
|||
|
|
<li class="right" >
|
|||
|
|
<a href="../py-modindex.html" title="Python Module Index"
|
|||
|
|
>modules</a> |</li>
|
|||
|
|
<li class="right" >
|
|||
|
|
<a href="curses.ascii.html" title="curses.ascii — Utilities for ASCII characters"
|
|||
|
|
>next</a> |</li>
|
|||
|
|
<li class="right" >
|
|||
|
|
<a href="getpass.html" title="getpass — Portable password input"
|
|||
|
|
>previous</a> |</li>
|
|||
|
|
<li><img src="../_static/py.png" alt=""
|
|||
|
|
style="vertical-align: middle; margin-top: -1px"/></li>
|
|||
|
|
<li><a href="https://www.python.org/">Python</a> »</li>
|
|||
|
|
<li>
|
|||
|
|
<span class="language_switcher_placeholder">en</span>
|
|||
|
|
<span class="version_switcher_placeholder">3.7.4</span>
|
|||
|
|
<a href="../index.html">Documentation </a> »
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li>
|
|||
|
|
<li class="nav-item nav-item-2"><a href="allos.html" >Generic Operating System Services</a> »</li>
|
|||
|
|
<li class="right">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="inline-search" style="display: none" role="search">
|
|||
|
|
<form class="inline-search" action="../search.html" method="get">
|
|||
|
|
<input placeholder="Quick search" type="text" name="q" />
|
|||
|
|
<input type="submit" value="Go" />
|
|||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|||
|
|
<input type="hidden" name="area" value="default" />
|
|||
|
|
</form>
|
|||
|
|
</div>
|
|||
|
|
<script type="text/javascript">$('.inline-search').show(0);</script>
|
|||
|
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
<div class="footer">
|
|||
|
|
© <a href="../copyright.html">Copyright</a> 2001-2019, Python Software Foundation.
|
|||
|
|
<br />
|
|||
|
|
The Python Software Foundation is a non-profit corporation.
|
|||
|
|
<a href="https://www.python.org/psf/donations/">Please donate.</a>
|
|||
|
|
<br />
|
|||
|
|
Last updated on Jul 13, 2019.
|
|||
|
|
<a href="../bugs.html">Found a bug</a>?
|
|||
|
|
<br />
|
|||
|
|
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 2.0.1.
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</body>
|
|||
|
|
</html>
|