Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
Watch 1
Star 0
Wiki 捐赠
gooderp18绿色标准版
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Tree: 0f75e31513
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '0f75e31513'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/curses.html

3551 lines
270KB
Raw Blame History 

  1. <!DOCTYPE html>

  2. 

  3. <html lang="en" data-content_root="../">

  4.   <head>

  5.     <meta charset="utf-8" />

  6.     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  7. <meta property="og:title" content="curses — Terminal handling for character-cell displays" />

  8. <meta property="og:type" content="website" />

  9. <meta property="og:url" content="https://docs.python.org/3/library/curses.html" />

  10. <meta property="og:site_name" content="Python documentation" />

  11. <meta property="og:description" content="Source code: Lib/curses The curses module provides an interface to the curses library, the de-facto standard for portable advanced terminal handling. While curses is most widely used in the Unix en..." />

  12. <meta property="og:image" content="https://docs.python.org/3/_static/og-image.png" />

  13. <meta property="og:image:alt" content="Python documentation" />

  14. <meta name="description" content="Source code: Lib/curses The curses module provides an interface to the curses library, the de-facto standard for portable advanced terminal handling. While curses is most widely used in the Unix en..." />

  15. <meta property="og:image:width" content="200" />

  16. <meta property="og:image:height" content="200" />

  17. <meta name="theme-color" content="#3776ab" />

  18. 

  19.     <title>curses — Terminal handling for character-cell displays &#8212; Python 3.12.3 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">

  20.     

  21.     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />

  22.     <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=bb723527" />

  23.     <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" />

  24.     

  25.     <script src="../_static/documentation_options.js?v=2c828074"></script>

  26.     <script src="../_static/doctools.js?v=888ff710"></script>

  27.     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

  28.     

  29.     <script src="../_static/sidebar.js"></script>

  30.     

  31.     <link rel="search" type="application/opensearchdescription+xml"

  32.           title="Search within Python 3.12.3 documentation"

  33.           href="../_static/opensearch.xml"/>

  34.     <link rel="author" title="About these documents" href="../about.html" />

  35.     <link rel="index" title="Index" href="../genindex.html" />

  36.     <link rel="search" title="Search" href="../search.html" />

  37.     <link rel="copyright" title="Copyright" href="../copyright.html" />

  38.     <link rel="next" title="curses.ascii — Utilities for ASCII characters" href="curses.ascii.html" />

  39.     <link rel="prev" title="getpass — Portable password input" href="getpass.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/library/curses.html" />

  41.     

  42.       

  43.     

  44. 

  45.     

  46.     <style>

  47.       @media only screen {

  48.         table.full-width-table {

  49.             width: 100%;

  50.         }

  51.       }

  52.     </style>

  53. <link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">

  54.     <link rel="shortcut icon" type="image/png" href="../_static/py.svg" />

  55.             <script type="text/javascript" src="../_static/copybutton.js"></script>

  56.             <script type="text/javascript" src="../_static/menu.js"></script>

  57.             <script type="text/javascript" src="../_static/search-focus.js"></script>

  58.             <script type="text/javascript" src="../_static/themetoggle.js"></script> 

  59. 

  60.   </head>

  61. <body>

  62. <div class="mobile-nav">

  63.     <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"

  64.            aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />

  65.     <nav class="nav-content" role="navigation">

  66.         <label for="menuToggler" class="toggler__label">

  67.             <span></span>

  68.         </label>

  69.         <span class="nav-items-wrapper">

  70.             <a href="https://www.python.org/" class="nav-logo">

  71.                 <img src="../_static/py.svg" alt="Python logo"/>

  72.             </a>

  73.             <span class="version_switcher_placeholder"></span>

  74.             <form role="search" class="search" action="../search.html" method="get">

  75.                 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">

  76.                     <path fill-rule="nonzero" fill="currentColor" d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path>

  77.                 </svg>

  78.                 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />

  79.                 <input type="submit" value="Go"/>

  80.             </form>

  81.         </span>

  82.     </nav>

  83.     <div class="menu-wrapper">

  84.         <nav class="menu" role="navigation" aria-label="main navigation">

  85.             <div class="language_switcher_placeholder"></div>

  86.             

  87. <label class="theme-selector-label">

  88.     Theme

  89.     <select class="theme-selector" oninput="activateTheme(this.value)">

  90.         <option value="auto" selected>Auto</option>

  91.         <option value="light">Light</option>

  92.         <option value="dark">Dark</option>

  93.     </select>

  94. </label>

  95.   <div>

  96.     <h3><a href="../contents.html">Table of Contents</a></h3>

  97.     <ul>

  98. <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>

  99. <li><a class="reference internal" href="#functions">Functions</a></li>

  100. <li><a class="reference internal" href="#window-objects">Window Objects</a></li>

  101. <li><a class="reference internal" href="#constants">Constants</a></li>

  102. </ul>

  103. </li>

  104. <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>

  105. <li><a class="reference internal" href="#textbox-objects">Textbox objects</a></li>

  106. </ul>

  107. </li>

  108. </ul>

  109. 

  110.   </div>

  111.   <div>

  112.     <h4>Previous topic</h4>

  113.     <p class="topless"><a href="getpass.html"

  114.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">getpass</span></code> — Portable password input</a></p>

  115.   </div>

  116.   <div>

  117.     <h4>Next topic</h4>

  118.     <p class="topless"><a href="curses.ascii.html"

  119.                           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>

  120.   </div>

  121.   <div role="note" aria-label="source link">

  122.     <h3>This Page</h3>

  123.     <ul class="this-page-menu">

  124.       <li><a href="../bugs.html">Report a Bug</a></li>

  125.       <li>

  126.         <a href="https://github.com/python/cpython/blob/main/Doc/library/curses.rst"

  127.             rel="nofollow">Show Source

  128.         </a>

  129.       </li>

  130.     </ul>

  131.   </div>

  132.         </nav>

  133.     </div>

  134. </div>

  135. 

  136.   

  137.     <div class="related" role="navigation" aria-label="related navigation">

  138.       <h3>Navigation</h3>

  139.       <ul>

  140.         <li class="right" style="margin-right: 10px">

  141.           <a href="../genindex.html" title="General Index"

  142.              accesskey="I">index</a></li>

  143.         <li class="right" >

  144.           <a href="../py-modindex.html" title="Python Module Index"

  145.              >modules</a> |</li>

  146.         <li class="right" >

  147.           <a href="curses.ascii.html" title="curses.ascii — Utilities for ASCII characters"

  148.              accesskey="N">next</a> |</li>

  149.         <li class="right" >

  150.           <a href="getpass.html" title="getpass — Portable password input"

  151.              accesskey="P">previous</a> |</li>

  152. 

  153.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  154.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  155.           <li class="switchers">

  156.             <div class="language_switcher_placeholder"></div>

  157.             <div class="version_switcher_placeholder"></div>

  158.           </li>

  159.           <li>

  160.               

  161.           </li>

  162.     <li id="cpython-language-and-version">

  163.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  164.     </li>

  165. 

  166.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  167.           <li class="nav-item nav-item-2"><a href="allos.html" accesskey="U">Generic Operating System Services</a> &#187;</li>

  168.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">curses</span></code> — Terminal handling for character-cell displays</a></li>

  169.                 <li class="right">

  170.                     

  171. 

  172.     <div class="inline-search" role="search">

  173.         <form class="inline-search" action="../search.html" method="get">

  174.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  175.           <input type="submit" value="Go" />

  176.         </form>

  177.     </div>

  178.                      |

  179.                 </li>

  180.             <li class="right">

  181. <label class="theme-selector-label">

  182.     Theme

  183.     <select class="theme-selector" oninput="activateTheme(this.value)">

  184.         <option value="auto" selected>Auto</option>

  185.         <option value="light">Light</option>

  186.         <option value="dark">Dark</option>

  187.     </select>

  188. </label> |</li>

  189.             

  190.       </ul>

  191.     </div>    

  192. 

  193.     <div class="document">

  194.       <div class="documentwrapper">

  195.         <div class="bodywrapper">

  196.           <div class="body" role="main">

  197.             

  198.   <section id="module-curses">

  199. <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="Link to this heading">¶</a></h1>

  200. <p><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/3.12/Lib/curses">Lib/curses</a></p>

  201. <hr class="docutils" />

  202. <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

  203. de-facto standard for portable advanced terminal handling.</p>

  204. <p>While curses is most widely used in the Unix environment, versions are available

  205. for Windows, DOS, and possibly other systems as well.  This extension module is

  206. designed to match the API of ncurses, an open-source curses library hosted on

  207. Linux and the BSD variants of Unix.</p>

  208. <div class="admonition note">

  209. <p class="admonition-title">Note</p>

  210. <p>Whenever the documentation mentions a <em>character</em> it can be specified

  211. as an integer, a one-character Unicode string or a one-byte byte string.</p>

  212. <p>Whenever the documentation mentions a <em>character string</em> it can be specified

  213. as a Unicode string or a byte string.</p>

  214. </div>

  215. <div class="admonition seealso">

  216. <p class="admonition-title">See also</p>

  217. <dl class="simple">

  218. <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>

  219. </dd>

  220. <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>

  221. </dd>

  222. <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>

  223. </dd>

  224. <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

  225. Raymond.</p>

  226. </dd>

  227. </dl>

  228. </div>

  229. <section id="functions">

  230. <span id="curses-functions"></span><h2>Functions<a class="headerlink" href="#functions" title="Link to this heading">¶</a></h2>

  231. <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>

  232. <dl class="py exception">

  233. <dt class="sig sig-object py" id="curses.error">

  234. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">error</span></span><a class="headerlink" href="#curses.error" title="Link to this definition">¶</a></dt>

  235. <dd><p>Exception raised when a curses library function returns an error.</p>

  236. </dd></dl>

  237. 

  238. <div class="admonition note">

  239. <p class="admonition-title">Note</p>

  240. <p>Whenever <em>x</em> or <em>y</em> arguments to a function or a method are optional, they

  241. default to the current cursor location. Whenever <em>attr</em> is optional, it defaults

  242. to <a class="reference internal" href="#curses.A_NORMAL" title="curses.A_NORMAL"><code class="xref py py-const docutils literal notranslate"><span class="pre">A_NORMAL</span></code></a>.</p>

  243. </div>

  244. <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>

  245. <dl class="py function">

  246. <dt class="sig sig-object py" id="curses.baudrate">

  247. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">baudrate</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.baudrate" title="Link to this definition">¶</a></dt>

  248. <dd><p>Return the output speed of the terminal in bits per second.  On software

  249. terminal emulators it will have a fixed high value. Included for historical

  250. reasons; in former times, it was used to  write output loops for time delays and

  251. occasionally to change interfaces depending on the line speed.</p>

  252. </dd></dl>

  253. 

  254. <dl class="py function">

  255. <dt class="sig sig-object py" id="curses.beep">

  256. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">beep</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.beep" title="Link to this definition">¶</a></dt>

  257. <dd><p>Emit a short attention sound.</p>

  258. </dd></dl>

  259. 

  260. <dl class="py function">

  261. <dt class="sig sig-object py" id="curses.can_change_color">

  262. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">can_change_color</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.can_change_color" title="Link to this definition">¶</a></dt>

  263. <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

  264. displayed by the terminal.</p>

  265. </dd></dl>

  266. 

  267. <dl class="py function">

  268. <dt class="sig sig-object py" id="curses.cbreak">

  269. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">cbreak</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.cbreak" title="Link to this definition">¶</a></dt>

  270. <dd><p>Enter cbreak mode.  In cbreak mode (sometimes called “rare” mode) normal tty

  271. line buffering is turned off and characters are available to be read one by one.

  272. However, unlike raw mode, special characters (interrupt, quit, suspend, and flow

  273. control) retain their effects on the tty driver and calling program.  Calling

  274. 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>

  275. </dd></dl>

  276. 

  277. <dl class="py function">

  278. <dt class="sig sig-object py" id="curses.color_content">

  279. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">color_content</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">color_number</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.color_content" title="Link to this definition">¶</a></dt>

  280. <dd><p>Return the intensity of the red, green, and blue (RGB) components in the color

  281. <em>color_number</em>, which must be between <code class="docutils literal notranslate"><span class="pre">0</span></code> and <code class="docutils literal notranslate"><span class="pre">COLORS</span> <span class="pre">-</span> <span class="pre">1</span></code>.  Return a 3-tuple,

  282. containing the R,G,B values for the given color, which will be between

  283. <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>

  284. </dd></dl>

  285. 

  286. <dl class="py function">

  287. <dt class="sig sig-object py" id="curses.color_pair">

  288. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">color_pair</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pair_number</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.color_pair" title="Link to this definition">¶</a></dt>

  289. <dd><p>Return the attribute value for displaying text in the specified color pair.

  290. Only the first 256 color pairs are supported. This

  291. attribute value can be combined with <a class="reference internal" href="#curses.A_STANDOUT" title="curses.A_STANDOUT"><code class="xref py py-const docutils literal notranslate"><span class="pre">A_STANDOUT</span></code></a>, <a class="reference internal" href="#curses.A_REVERSE" title="curses.A_REVERSE"><code class="xref py py-const docutils literal notranslate"><span class="pre">A_REVERSE</span></code></a>,

  292. 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

  293. to this function.</p>

  294. </dd></dl>

  295. 

  296. <dl class="py function">

  297. <dt class="sig sig-object py" id="curses.curs_set">

  298. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">curs_set</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">visibility</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.curs_set" title="Link to this definition">¶</a></dt>

  299. <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,

  300. normal, or very visible.  If the terminal supports the visibility requested, return the

  301. previous cursor state; otherwise raise an exception.  On many

  302. terminals, the “visible” mode is an underline cursor and the “very visible” mode

  303. is a block cursor.</p>

  304. </dd></dl>

  305. 

  306. <dl class="py function">

  307. <dt class="sig sig-object py" id="curses.def_prog_mode">

  308. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">def_prog_mode</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.def_prog_mode" title="Link to this definition">¶</a></dt>

  309. <dd><p>Save the current terminal mode as the “program” mode, the mode when the running

  310. program is using curses.  (Its counterpart is the “shell” mode, for when the

  311. 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

  312. restore this mode.</p>

  313. </dd></dl>

  314. 

  315. <dl class="py function">

  316. <dt class="sig sig-object py" id="curses.def_shell_mode">

  317. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">def_shell_mode</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.def_shell_mode" title="Link to this definition">¶</a></dt>

  318. <dd><p>Save the current terminal mode as the “shell” mode, the mode when the running

  319. program is not using curses.  (Its counterpart is the “program” mode, when the

  320. program is using curses capabilities.) Subsequent calls to

  321. <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>

  322. </dd></dl>

  323. 

  324. <dl class="py function">

  325. <dt class="sig sig-object py" id="curses.delay_output">

  326. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">delay_output</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ms</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.delay_output" title="Link to this definition">¶</a></dt>

  327. <dd><p>Insert an <em>ms</em> millisecond pause in output.</p>

  328. </dd></dl>

  329. 

  330. <dl class="py function">

  331. <dt class="sig sig-object py" id="curses.doupdate">

  332. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">doupdate</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.doupdate" title="Link to this definition">¶</a></dt>

  333. <dd><p>Update the physical screen.  The curses library keeps two data structures, one

  334. representing the current physical screen contents and a virtual screen

  335. 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

  336. physical screen to match the virtual screen.</p>

  337. <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

  338. 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

  339. <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>;

  340. if you have to update multiple windows, you can speed performance and perhaps

  341. reduce screen flicker by issuing <code class="xref py py-meth docutils literal notranslate"><span class="pre">noutrefresh()</span></code> calls on all windows,

  342. followed by a single <code class="xref py py-func docutils literal notranslate"><span class="pre">doupdate()</span></code>.</p>

  343. </dd></dl>

  344. 

  345. <dl class="py function">

  346. <dt class="sig sig-object py" id="curses.echo">

  347. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">echo</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.echo" title="Link to this definition">¶</a></dt>

  348. <dd><p>Enter echo mode.  In echo mode, each character input is echoed to the screen as

  349. it is entered.</p>

  350. </dd></dl>

  351. 

  352. <dl class="py function">

  353. <dt class="sig sig-object py" id="curses.endwin">

  354. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">endwin</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.endwin" title="Link to this definition">¶</a></dt>

  355. <dd><p>De-initialize the library, and return terminal to normal status.</p>

  356. </dd></dl>

  357. 

  358. <dl class="py function">

  359. <dt class="sig sig-object py" id="curses.erasechar">

  360. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">erasechar</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.erasechar" title="Link to this definition">¶</a></dt>

  361. <dd><p>Return the user’s current erase character as a one-byte bytes object.  Under Unix operating systems this

  362. is a property of the controlling tty of the curses program, and is not set by

  363. the curses library itself.</p>

  364. </dd></dl>

  365. 

  366. <dl class="py function">

  367. <dt class="sig sig-object py" id="curses.filter">

  368. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">filter</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.filter" title="Link to this definition">¶</a></dt>

  369. <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

  370. 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

  371. 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>

  372. 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

  373. the current line, and so are screen updates.  This may be used for enabling

  374. character-at-a-time  line editing without touching the rest of the screen.</p>

  375. </dd></dl>

  376. 

  377. <dl class="py function">

  378. <dt class="sig sig-object py" id="curses.flash">

  379. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">flash</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.flash" title="Link to this definition">¶</a></dt>

  380. <dd><p>Flash the screen.  That is, change it to reverse-video and then change it back

  381. in a short interval.  Some people prefer such as ‘visible bell’ to the audible

  382. 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>

  383. </dd></dl>

  384. 

  385. <dl class="py function">

  386. <dt class="sig sig-object py" id="curses.flushinp">

  387. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">flushinp</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.flushinp" title="Link to this definition">¶</a></dt>

  388. <dd><p>Flush all input buffers.  This throws away any  typeahead  that  has been typed

  389. by the user and has not yet been processed by the program.</p>

  390. </dd></dl>

  391. 

  392. <dl class="py function">

  393. <dt class="sig sig-object py" id="curses.getmouse">

  394. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">getmouse</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.getmouse" title="Link to this definition">¶</a></dt>

  395. <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 <a class="reference internal" href="#curses.KEY_MOUSE" title="curses.KEY_MOUSE"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_MOUSE</span></code></a> to signal a mouse event, this

  396. method should be called to retrieve the queued mouse event, represented as a

  397. 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

  398. multiple devices, and <em>x</em>, <em>y</em>, <em>z</em> are the event’s coordinates.  (<em>z</em> is

  399. currently unused.)  <em>bstate</em> is an integer value whose bits will be set to

  400. indicate the type of event, and will be the bitwise OR of one or more of the

  401. following constants, where <em>n</em> is the button number from 1 to 5:

  402. <a class="reference internal" href="#curses.BUTTONn_PRESSED" title="curses.BUTTONn_PRESSED"><code class="xref py py-const docutils literal notranslate"><span class="pre">BUTTONn_PRESSED</span></code></a>, <a class="reference internal" href="#curses.BUTTONn_RELEASED" title="curses.BUTTONn_RELEASED"><code class="xref py py-const docutils literal notranslate"><span class="pre">BUTTONn_RELEASED</span></code></a>, <a class="reference internal" href="#curses.BUTTONn_CLICKED" title="curses.BUTTONn_CLICKED"><code class="xref py py-const docutils literal notranslate"><span class="pre">BUTTONn_CLICKED</span></code></a>,

  403. <a class="reference internal" href="#curses.BUTTONn_DOUBLE_CLICKED" title="curses.BUTTONn_DOUBLE_CLICKED"><code class="xref py py-const docutils literal notranslate"><span class="pre">BUTTONn_DOUBLE_CLICKED</span></code></a>, <a class="reference internal" href="#curses.BUTTONn_TRIPLE_CLICKED" title="curses.BUTTONn_TRIPLE_CLICKED"><code class="xref py py-const docutils literal notranslate"><span class="pre">BUTTONn_TRIPLE_CLICKED</span></code></a>,

  404. <a class="reference internal" href="#curses.BUTTON_SHIFT" title="curses.BUTTON_SHIFT"><code class="xref py py-const docutils literal notranslate"><span class="pre">BUTTON_SHIFT</span></code></a>, <a class="reference internal" href="#curses.BUTTON_CTRL" title="curses.BUTTON_CTRL"><code class="xref py py-const docutils literal notranslate"><span class="pre">BUTTON_CTRL</span></code></a>, <a class="reference internal" href="#curses.BUTTON_ALT" title="curses.BUTTON_ALT"><code class="xref py py-const docutils literal notranslate"><span class="pre">BUTTON_ALT</span></code></a>.</p>

  405. <div class="versionchanged">

  406. <p><span class="versionmodified changed">Changed in version 3.10: </span>The <code class="docutils literal notranslate"><span class="pre">BUTTON5_*</span></code> constants are now exposed if they are provided by the

  407. underlying curses library.</p>

  408. </div>

  409. </dd></dl>

  410. 

  411. <dl class="py function">

  412. <dt class="sig sig-object py" id="curses.getsyx">

  413. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">getsyx</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.getsyx" title="Link to this definition">¶</a></dt>

  414. <dd><p>Return the current coordinates of the virtual screen cursor as a tuple

  415. <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>

  416. </dd></dl>

  417. 

  418. <dl class="py function">

  419. <dt class="sig sig-object py" id="curses.getwin">

  420. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">getwin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.getwin" title="Link to this definition">¶</a></dt>

  421. <dd><p>Read window related data stored in the file by an earlier <a class="reference internal" href="#curses.window.putwin" title="curses.window.putwin"><code class="xref py py-func docutils literal notranslate"><span class="pre">window.putwin()</span></code></a> call.

  422. The routine then creates and initializes a new window using that data, returning

  423. the new window object.</p>

  424. </dd></dl>

  425. 

  426. <dl class="py function">

  427. <dt class="sig sig-object py" id="curses.has_colors">

  428. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">has_colors</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.has_colors" title="Link to this definition">¶</a></dt>

  429. <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>

  430. </dd></dl>

  431. 

  432. <dl class="py function">

  433. <dt class="sig sig-object py" id="curses.has_extended_color_support">

  434. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">has_extended_color_support</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.has_extended_color_support" title="Link to this definition">¶</a></dt>

  435. <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the module supports extended colors; otherwise, return

  436. <code class="docutils literal notranslate"><span class="pre">False</span></code>. Extended color support allows more than 256 color pairs for

  437. terminals that support more than 16 colors (e.g. xterm-256color).</p>

  438. <p>Extended color support requires ncurses version 6.1 or later.</p>

  439. <div class="versionadded">

  440. <p><span class="versionmodified added">New in version 3.10.</span></p>

  441. </div>

  442. </dd></dl>

  443. 

  444. <dl class="py function">

  445. <dt class="sig sig-object py" id="curses.has_ic">

  446. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">has_ic</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.has_ic" title="Link to this definition">¶</a></dt>

  447. <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the terminal has insert- and delete-character capabilities.

  448. This function is included for historical reasons only, as all modern software

  449. terminal emulators have such capabilities.</p>

  450. </dd></dl>

  451. 

  452. <dl class="py function">

  453. <dt class="sig sig-object py" id="curses.has_il">

  454. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">has_il</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.has_il" title="Link to this definition">¶</a></dt>

  455. <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

  456. simulate  them  using scrolling regions. This function is included for

  457. historical reasons only, as all modern software terminal emulators have such

  458. capabilities.</p>

  459. </dd></dl>

  460. 

  461. <dl class="py function">

  462. <dt class="sig sig-object py" id="curses.has_key">

  463. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">has_key</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ch</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.has_key" title="Link to this definition">¶</a></dt>

  464. <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

  465. a key with that value.</p>

  466. </dd></dl>

  467. 

  468. <dl class="py function">

  469. <dt class="sig sig-object py" id="curses.halfdelay">

  470. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">halfdelay</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tenths</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.halfdelay" title="Link to this definition">¶</a></dt>

  471. <dd><p>Used for half-delay mode, which is similar to cbreak mode in that characters

  472. typed by the user are immediately available to the program. However, after

  473. blocking for <em>tenths</em> tenths of seconds, raise an exception if nothing has

  474. 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

  475. <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>

  476. </dd></dl>

  477. 

  478. <dl class="py function">

  479. <dt class="sig sig-object py" id="curses.init_color">

  480. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">init_color</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">color_number</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">r</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">g</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">b</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.init_color" title="Link to this definition">¶</a></dt>

  481. <dd><p>Change the definition of a color, taking the number of the color to be changed

  482. followed by three RGB values (for the amounts of red, green, and blue

  483. components).  The value of <em>color_number</em> must be between <code class="docutils literal notranslate"><span class="pre">0</span></code> and

  484. <code class="docutils literal notranslate"><span class="pre">COLORS</span> <span class="pre">-</span> <span class="pre">1</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

  485. <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

  486. screen immediately change to the new definition.  This function is a no-op on

  487. 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>

  488. </dd></dl>

  489. 

  490. <dl class="py function">

  491. <dt class="sig sig-object py" id="curses.init_pair">

  492. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">init_pair</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pair_number</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bg</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.init_pair" title="Link to this definition">¶</a></dt>

  493. <dd><p>Change the definition of a color-pair.  It takes three arguments: the number of

  494. the color-pair to be changed, the foreground color number, and the background

  495. color number.  The value of <em>pair_number</em> must be between <code class="docutils literal notranslate"><span class="pre">1</span></code> and

  496. <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

  497. 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

  498. <code class="docutils literal notranslate"><span class="pre">COLORS</span> <span class="pre">-</span> <span class="pre">1</span></code>, or, after calling <a class="reference internal" href="#curses.use_default_colors" title="curses.use_default_colors"><code class="xref py py-func docutils literal notranslate"><span class="pre">use_default_colors()</span></code></a>, <code class="docutils literal notranslate"><span class="pre">-1</span></code>.

  499. If the color-pair was previously initialized, the screen is

  500. refreshed and all occurrences of that color-pair are changed to the new

  501. definition.</p>

  502. </dd></dl>

  503. 

  504. <dl class="py function">

  505. <dt class="sig sig-object py" id="curses.initscr">

  506. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">initscr</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.initscr" title="Link to this definition">¶</a></dt>

  507. <dd><p>Initialize the library. Return a <a class="reference internal" href="#curses-window-objects"><span class="std std-ref">window</span></a> object

  508. which represents the whole screen.</p>

  509. <div class="admonition note">

  510. <p class="admonition-title">Note</p>

  511. <p>If there is an error opening the terminal, the underlying curses library may

  512. cause the interpreter to exit.</p>

  513. </div>

  514. </dd></dl>

  515. 

  516. <dl class="py function">

  517. <dt class="sig sig-object py" id="curses.is_term_resized">

  518. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">is_term_resized</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nlines</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ncols</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.is_term_resized" title="Link to this definition">¶</a></dt>

  519. <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,

  520. <code class="docutils literal notranslate"><span class="pre">False</span></code> otherwise.</p>

  521. </dd></dl>

  522. 

  523. <dl class="py function">

  524. <dt class="sig sig-object py" id="curses.isendwin">

  525. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">isendwin</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.isendwin" title="Link to this definition">¶</a></dt>

  526. <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

  527. been deinitialized).</p>

  528. </dd></dl>

  529. 

  530. <dl class="py function">

  531. <dt class="sig sig-object py" id="curses.keyname">

  532. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">keyname</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">k</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.keyname" title="Link to this definition">¶</a></dt>

  533. <dd><p>Return the name of the key numbered <em>k</em> as a bytes object.  The name of a key generating printable

  534. ASCII character is the key’s character.  The name of a control-key combination

  535. 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

  536. printable ASCII character.  The name of an alt-key combination (128–255) is a

  537. 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

  538. ASCII character.</p>

  539. </dd></dl>

  540. 

  541. <dl class="py function">

  542. <dt class="sig sig-object py" id="curses.killchar">

  543. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">killchar</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.killchar" title="Link to this definition">¶</a></dt>

  544. <dd><p>Return the user’s current line kill character as a one-byte bytes object. Under Unix operating systems

  545. this is a property of the controlling tty of the curses program, and is not set

  546. by the curses library itself.</p>

  547. </dd></dl>

  548. 

  549. <dl class="py function">

  550. <dt class="sig sig-object py" id="curses.longname">

  551. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">longname</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.longname" title="Link to this definition">¶</a></dt>

  552. <dd><p>Return a bytes object containing the terminfo long name field describing the current

  553. terminal.  The maximum length of a verbose description is 128 characters.  It is

  554. 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>

  555. </dd></dl>

  556. 

  557. <dl class="py function">

  558. <dt class="sig sig-object py" id="curses.meta">

  559. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">meta</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flag</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.meta" title="Link to this definition">¶</a></dt>

  560. <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

  561. <em>flag</em> is <code class="docutils literal notranslate"><span class="pre">False</span></code>,  allow only 7-bit chars.</p>

  562. </dd></dl>

  563. 

  564. <dl class="py function">

  565. <dt class="sig sig-object py" id="curses.mouseinterval">

  566. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">mouseinterval</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">interval</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.mouseinterval" title="Link to this definition">¶</a></dt>

  567. <dd><p>Set the maximum time in milliseconds that can elapse between press and release

  568. events in order for them to be recognized as a click, and return the previous

  569. interval value.  The default value is 200 milliseconds, or one fifth of a second.</p>

  570. </dd></dl>

  571. 

  572. <dl class="py function">

  573. <dt class="sig sig-object py" id="curses.mousemask">

  574. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">mousemask</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mousemask</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.mousemask" title="Link to this definition">¶</a></dt>

  575. <dd><p>Set the mouse events to be reported, and return a tuple <code class="docutils literal notranslate"><span class="pre">(availmask,</span>

  576. <span class="pre">oldmask)</span></code>.   <em>availmask</em> indicates which of the specified mouse events can be

  577. 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

  578. the given window’s mouse event mask.  If this function is never called, no mouse

  579. events are ever reported.</p>

  580. </dd></dl>

  581. 

  582. <dl class="py function">

  583. <dt class="sig sig-object py" id="curses.napms">

  584. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">napms</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ms</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.napms" title="Link to this definition">¶</a></dt>

  585. <dd><p>Sleep for <em>ms</em> milliseconds.</p>

  586. </dd></dl>

  587. 

  588. <dl class="py function">

  589. <dt class="sig sig-object py" id="curses.newpad">

  590. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">newpad</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nlines</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ncols</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.newpad" title="Link to this definition">¶</a></dt>

  591. <dd><p>Create and return a pointer to a new pad data structure with the given number

  592. of lines and columns.  Return a pad as a window object.</p>

  593. <p>A pad is like a window, except that it is not restricted by the screen size, and

  594. is not necessarily associated with a particular part of the screen.  Pads can be

  595. used when a large window is needed, and only a part of the window will be on the

  596. screen at one time.  Automatic refreshes of pads (such as from scrolling or

  597. 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>

  598. methods of a pad require 6 arguments to specify the part of the pad to be

  599. displayed and the location on the screen to be used for the display. The

  600. arguments are <em>pminrow</em>, <em>pmincol</em>, <em>sminrow</em>, <em>smincol</em>, <em>smaxrow</em>, <em>smaxcol</em>; the <em>p</em>

  601. arguments refer to the upper left corner of the pad region to be displayed and

  602. the <em>s</em> arguments define a clipping box on the screen within which the pad region

  603. is to be displayed.</p>

  604. </dd></dl>

  605. 

  606. <dl class="py function">

  607. <dt class="sig sig-object py" id="curses.newwin">

  608. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">newwin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nlines</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ncols</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.newwin" title="Link to this definition">¶</a></dt>

  609. <dt class="sig sig-object py">

  610. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">newwin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nlines</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ncols</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">begin_y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">begin_x</span></span></em><span class="sig-paren">)</span></dt>

  611. <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

  612. 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>

  613. <p>By default, the window will extend from the  specified position to the lower

  614. right corner of the screen.</p>

  615. </dd></dl>

  616. 

  617. <dl class="py function">

  618. <dt class="sig sig-object py" id="curses.nl">

  619. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">nl</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.nl" title="Link to this definition">¶</a></dt>

  620. <dd><p>Enter newline mode.  This mode translates the return key into newline on input,

  621. and translates newline into return and line-feed on output. Newline mode is

  622. initially on.</p>

  623. </dd></dl>

  624. 

  625. <dl class="py function">

  626. <dt class="sig sig-object py" id="curses.nocbreak">

  627. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">nocbreak</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.nocbreak" title="Link to this definition">¶</a></dt>

  628. <dd><p>Leave cbreak mode.  Return to normal “cooked” mode with line buffering.</p>

  629. </dd></dl>

  630. 

  631. <dl class="py function">

  632. <dt class="sig sig-object py" id="curses.noecho">

  633. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">noecho</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.noecho" title="Link to this definition">¶</a></dt>

  634. <dd><p>Leave echo mode.  Echoing of input characters is turned off.</p>

  635. </dd></dl>

  636. 

  637. <dl class="py function">

  638. <dt class="sig sig-object py" id="curses.nonl">

  639. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">nonl</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.nonl" title="Link to this definition">¶</a></dt>

  640. <dd><p>Leave newline mode.  Disable translation of return into newline on input, and

  641. disable low-level translation of newline into newline/return on output (but this

  642. does not change the behavior of <code class="docutils literal notranslate"><span class="pre">addch('\n')</span></code>, which always does the

  643. equivalent of return and line feed on the virtual screen).  With translation

  644. off, curses can sometimes speed up vertical motion a little; also, it will be

  645. able to detect the return key on input.</p>

  646. </dd></dl>

  647. 

  648. <dl class="py function">

  649. <dt class="sig sig-object py" id="curses.noqiflush">

  650. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">noqiflush</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.noqiflush" title="Link to this definition">¶</a></dt>

  651. <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

  652. 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

  653. 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

  654. continue as though the interrupt had not occurred, after the handler exits.</p>

  655. </dd></dl>

  656. 

  657. <dl class="py function">

  658. <dt class="sig sig-object py" id="curses.noraw">

  659. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">noraw</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.noraw" title="Link to this definition">¶</a></dt>

  660. <dd><p>Leave raw mode. Return to normal “cooked” mode with line buffering.</p>

  661. </dd></dl>

  662. 

  663. <dl class="py function">

  664. <dt class="sig sig-object py" id="curses.pair_content">

  665. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">pair_content</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pair_number</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.pair_content" title="Link to this definition">¶</a></dt>

  666. <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.

  667. The value of <em>pair_number</em> must be between <code class="docutils literal notranslate"><span class="pre">0</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>

  668. </dd></dl>

  669. 

  670. <dl class="py function">

  671. <dt class="sig sig-object py" id="curses.pair_number">

  672. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">pair_number</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">attr</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.pair_number" title="Link to this definition">¶</a></dt>

  673. <dd><p>Return the number of the color-pair set by the attribute value <em>attr</em>.

  674. <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>

  675. </dd></dl>

  676. 

  677. <dl class="py function">

  678. <dt class="sig sig-object py" id="curses.putp">

  679. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">putp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.putp" title="Link to this definition">¶</a></dt>

  680. <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

  681. 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>

  682. always goes to standard output.</p>

  683. </dd></dl>

  684. 

  685. <dl class="py function">

  686. <dt class="sig sig-object py" id="curses.qiflush">

  687. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">qiflush</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="n"><span class="pre">flag</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.qiflush" title="Link to this definition">¶</a></dt>

  688. <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

  689. <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

  690. these control characters are read.</p>

  691. </dd></dl>

  692. 

  693. <dl class="py function">

  694. <dt class="sig sig-object py" id="curses.raw">

  695. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">raw</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.raw" title="Link to this definition">¶</a></dt>

  696. <dd><p>Enter raw mode.  In raw mode, normal line buffering and  processing of

  697. interrupt, quit, suspend, and flow control keys are turned off; characters are

  698. presented to curses input functions one by one.</p>

  699. </dd></dl>

  700. 

  701. <dl class="py function">

  702. <dt class="sig sig-object py" id="curses.reset_prog_mode">

  703. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">reset_prog_mode</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.reset_prog_mode" title="Link to this definition">¶</a></dt>

  704. <dd><p>Restore the  terminal  to “program” mode, as previously saved  by

  705. <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>

  706. </dd></dl>

  707. 

  708. <dl class="py function">

  709. <dt class="sig sig-object py" id="curses.reset_shell_mode">

  710. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">reset_shell_mode</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.reset_shell_mode" title="Link to this definition">¶</a></dt>

  711. <dd><p>Restore the  terminal  to “shell” mode, as previously saved  by

  712. <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>

  713. </dd></dl>

  714. 

  715. <dl class="py function">

  716. <dt class="sig sig-object py" id="curses.resetty">

  717. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">resetty</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.resetty" title="Link to this definition">¶</a></dt>

  718. <dd><p>Restore the state of the terminal modes to what it was at the last call to

  719. <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>

  720. </dd></dl>

  721. 

  722. <dl class="py function">

  723. <dt class="sig sig-object py" id="curses.resize_term">

  724. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">resize_term</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nlines</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ncols</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.resize_term" title="Link to this definition">¶</a></dt>

  725. <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;

  726. 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

  727. extended.  The calling application should fill in these areas with

  728. appropriate data.  The <code class="xref py py-func docutils literal notranslate"><span class="pre">resize_term()</span></code> function attempts to resize all

  729. windows.  However, due to the calling convention of pads, it is not possible

  730. to resize these without additional interaction with the application.</p>

  731. </dd></dl>

  732. 

  733. <dl class="py function">

  734. <dt class="sig sig-object py" id="curses.resizeterm">

  735. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">resizeterm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nlines</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ncols</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.resizeterm" title="Link to this definition">¶</a></dt>

  736. <dd><p>Resize the standard and current windows to the specified dimensions, and

  737. adjusts other bookkeeping data used by the curses library that record the

  738. window dimensions (in particular the SIGWINCH handler).</p>

  739. </dd></dl>

  740. 

  741. <dl class="py function">

  742. <dt class="sig sig-object py" id="curses.savetty">

  743. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">savetty</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.savetty" title="Link to this definition">¶</a></dt>

  744. <dd><p>Save the current state of the terminal modes in a buffer, usable by

  745. <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>

  746. </dd></dl>

  747. 

  748. <dl class="py function">

  749. <dt class="sig sig-object py" id="curses.get_escdelay">

  750. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">get_escdelay</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.get_escdelay" title="Link to this definition">¶</a></dt>

  751. <dd><p>Retrieves the value set by <a class="reference internal" href="#curses.set_escdelay" title="curses.set_escdelay"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_escdelay()</span></code></a>.</p>

  752. <div class="versionadded">

  753. <p><span class="versionmodified added">New in version 3.9.</span></p>

  754. </div>

  755. </dd></dl>

  756. 

  757. <dl class="py function">

  758. <dt class="sig sig-object py" id="curses.set_escdelay">

  759. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">set_escdelay</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ms</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.set_escdelay" title="Link to this definition">¶</a></dt>

  760. <dd><p>Sets the number of milliseconds to wait after reading an escape character,

  761. to distinguish between an individual escape character entered on the

  762. keyboard from escape sequences sent by cursor and function keys.</p>

  763. <div class="versionadded">

  764. <p><span class="versionmodified added">New in version 3.9.</span></p>

  765. </div>

  766. </dd></dl>

  767. 

  768. <dl class="py function">

  769. <dt class="sig sig-object py" id="curses.get_tabsize">

  770. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">get_tabsize</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.get_tabsize" title="Link to this definition">¶</a></dt>

  771. <dd><p>Retrieves the value set by <a class="reference internal" href="#curses.set_tabsize" title="curses.set_tabsize"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_tabsize()</span></code></a>.</p>

  772. <div class="versionadded">

  773. <p><span class="versionmodified added">New in version 3.9.</span></p>

  774. </div>

  775. </dd></dl>

  776. 

  777. <dl class="py function">

  778. <dt class="sig sig-object py" id="curses.set_tabsize">

  779. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">set_tabsize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">size</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.set_tabsize" title="Link to this definition">¶</a></dt>

  780. <dd><p>Sets the number of columns used by the curses library when converting a tab

  781. character to spaces as it adds the tab to a window.</p>

  782. <div class="versionadded">

  783. <p><span class="versionmodified added">New in version 3.9.</span></p>

  784. </div>

  785. </dd></dl>

  786. 

  787. <dl class="py function">

  788. <dt class="sig sig-object py" id="curses.setsyx">

  789. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">setsyx</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.setsyx" title="Link to this definition">¶</a></dt>

  790. <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

  791. <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>

  792. </dd></dl>

  793. 

  794. <dl class="py function">

  795. <dt class="sig sig-object py" id="curses.setupterm">

  796. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">setupterm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">term</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fd</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.setupterm" title="Link to this definition">¶</a></dt>

  797. <dd><p>Initialize the terminal.  <em>term</em> is a string giving

  798. 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

  799. <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

  800. file descriptor to which any initialization sequences will be sent; if not

  801. 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>

  802. </dd></dl>

  803. 

  804. <dl class="py function">

  805. <dt class="sig sig-object py" id="curses.start_color">

  806. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">start_color</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.start_color" title="Link to this definition">¶</a></dt>

  807. <dd><p>Must be called if the programmer wants to use colors, and before any other color

  808. manipulation routine is called.  It is good practice to call this routine right

  809. 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>

  810. <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,

  811. 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>

  812. module, <a class="reference internal" href="#curses.COLORS" title="curses.COLORS"><code class="xref py py-const docutils literal notranslate"><span class="pre">COLORS</span></code></a> and <a class="reference internal" href="#curses.COLOR_PAIRS" title="curses.COLOR_PAIRS"><code class="xref py py-const docutils literal notranslate"><span class="pre">COLOR_PAIRS</span></code></a>, containing the maximum number

  813. of colors and color-pairs the terminal can support.  It also restores the colors

  814. on the terminal to the values they had when the terminal was just turned on.</p>

  815. </dd></dl>

  816. 

  817. <dl class="py function">

  818. <dt class="sig sig-object py" id="curses.termattrs">

  819. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">termattrs</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.termattrs" title="Link to this definition">¶</a></dt>

  820. <dd><p>Return a logical OR of all video attributes supported by the terminal.  This

  821. information is useful when a curses program needs complete control over the

  822. appearance of the screen.</p>

  823. </dd></dl>

  824. 

  825. <dl class="py function">

  826. <dt class="sig sig-object py" id="curses.termname">

  827. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">termname</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.termname" title="Link to this definition">¶</a></dt>

  828. <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,

  829. truncated to 14 characters.</p>

  830. </dd></dl>

  831. 

  832. <dl class="py function">

  833. <dt class="sig sig-object py" id="curses.tigetflag">

  834. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">tigetflag</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">capname</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.tigetflag" title="Link to this definition">¶</a></dt>

  835. <dd><p>Return the value of the Boolean capability corresponding to the terminfo

  836. 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

  837. Boolean capability, or <code class="docutils literal notranslate"><span class="pre">0</span></code> if it is canceled or absent from the terminal

  838. description.</p>

  839. </dd></dl>

  840. 

  841. <dl class="py function">

  842. <dt class="sig sig-object py" id="curses.tigetnum">

  843. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">tigetnum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">capname</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.tigetnum" title="Link to this definition">¶</a></dt>

  844. <dd><p>Return the value of the numeric capability corresponding to the terminfo

  845. 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

  846. numeric capability, or <code class="docutils literal notranslate"><span class="pre">-1</span></code> if it is canceled or absent from the terminal

  847. description.</p>

  848. </dd></dl>

  849. 

  850. <dl class="py function">

  851. <dt class="sig sig-object py" id="curses.tigetstr">

  852. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">tigetstr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">capname</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.tigetstr" title="Link to this definition">¶</a></dt>

  853. <dd><p>Return the value of the string capability corresponding to the terminfo

  854. 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>

  855. is not a terminfo “string capability”, or is canceled or absent from the

  856. terminal description.</p>

  857. </dd></dl>

  858. 

  859. <dl class="py function">

  860. <dt class="sig sig-object py" id="curses.tparm">

  861. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">tparm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">str</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">...</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.tparm" title="Link to this definition">¶</a></dt>

  862. <dd><p>Instantiate the bytes object <em>str</em> with the supplied parameters, where <em>str</em> should

  863. be a parameterized string obtained from the terminfo database.  E.g.

  864. <code class="docutils literal notranslate"><span class="pre">tparm(tigetstr(&quot;cup&quot;),</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

  865. result depending on terminal type.</p>

  866. </dd></dl>

  867. 

  868. <dl class="py function">

  869. <dt class="sig sig-object py" id="curses.typeahead">

  870. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">typeahead</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fd</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.typeahead" title="Link to this definition">¶</a></dt>

  871. <dd><p>Specify that the file descriptor <em>fd</em> be used for typeahead checking.  If <em>fd</em>

  872. is <code class="docutils literal notranslate"><span class="pre">-1</span></code>, then no typeahead checking is done.</p>

  873. <p>The curses library does “line-breakout optimization” by looking for typeahead

  874. periodically while updating the screen.  If input is found, and it is coming

  875. from a tty, the current update is postponed until refresh or doupdate is called

  876. again, allowing faster response to commands typed in advance. This function

  877. allows specifying a different file descriptor for typeahead checking.</p>

  878. </dd></dl>

  879. 

  880. <dl class="py function">

  881. <dt class="sig sig-object py" id="curses.unctrl">

  882. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">unctrl</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ch</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.unctrl" title="Link to this definition">¶</a></dt>

  883. <dd><p>Return a bytes object which is a printable representation of the character <em>ch</em>.

  884. Control characters are represented as a caret followed by the character, for

  885. example as <code class="docutils literal notranslate"><span class="pre">b'^C'</span></code>. Printing characters are left as they are.</p>

  886. </dd></dl>

  887. 

  888. <dl class="py function">

  889. <dt class="sig sig-object py" id="curses.ungetch">

  890. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ungetch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ch</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.ungetch" title="Link to this definition">¶</a></dt>

  891. <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>

  892. <div class="admonition note">

  893. <p class="admonition-title">Note</p>

  894. <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>

  895. </div>

  896. </dd></dl>

  897. 

  898. <dl class="py function">

  899. <dt class="sig sig-object py" id="curses.update_lines_cols">

  900. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">update_lines_cols</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.update_lines_cols" title="Link to this definition">¶</a></dt>

  901. <dd><p>Update the <a class="reference internal" href="#curses.LINES" title="curses.LINES"><code class="xref py py-const docutils literal notranslate"><span class="pre">LINES</span></code></a> and <a class="reference internal" href="#curses.COLS" title="curses.COLS"><code class="xref py py-const docutils literal notranslate"><span class="pre">COLS</span></code></a> module variables.

  902. Useful for detecting manual screen resize.</p>

  903. <div class="versionadded">

  904. <p><span class="versionmodified added">New in version 3.5.</span></p>

  905. </div>

  906. </dd></dl>

  907. 

  908. <dl class="py function">

  909. <dt class="sig sig-object py" id="curses.unget_wch">

  910. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">unget_wch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ch</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.unget_wch" title="Link to this definition">¶</a></dt>

  911. <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>

  912. <div class="admonition note">

  913. <p class="admonition-title">Note</p>

  914. <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>

  915. </div>

  916. <div class="versionadded">

  917. <p><span class="versionmodified added">New in version 3.3.</span></p>

  918. </div>

  919. </dd></dl>

  920. 

  921. <dl class="py function">

  922. <dt class="sig sig-object py" id="curses.ungetmouse">

  923. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ungetmouse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">z</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bstate</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.ungetmouse" title="Link to this definition">¶</a></dt>

  924. <dd><p>Push a <a class="reference internal" href="#curses.KEY_MOUSE" title="curses.KEY_MOUSE"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_MOUSE</span></code></a> event onto the input queue, associating the given

  925. state data with it.</p>

  926. </dd></dl>

  927. 

  928. <dl class="py function">

  929. <dt class="sig sig-object py" id="curses.use_env">

  930. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">use_env</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flag</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.use_env" title="Link to this definition">¶</a></dt>

  931. <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

  932. 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

  933. terminfo database will be used, even if environment variables <span class="target" id="index-3"></span><code class="xref std std-envvar docutils literal notranslate"><span class="pre">LINES</span></code>

  934. and <span class="target" id="index-4"></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

  935. window (in which case default behavior would be to use the window size if

  936. <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> are not set).</p>

  937. </dd></dl>

  938. 

  939. <dl class="py function">

  940. <dt class="sig sig-object py" id="curses.use_default_colors">

  941. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">use_default_colors</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.use_default_colors" title="Link to this definition">¶</a></dt>

  942. <dd><p>Allow use of default values for colors on terminals supporting this feature. Use

  943. this to support transparency in your application.  The default color is assigned

  944. 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>

  945. <span class="pre">curses.COLOR_RED,</span> <span class="pre">-1)</span></code> initializes, for instance, color pair <em>x</em> to a red

  946. foreground color on the default background.</p>

  947. </dd></dl>

  948. 

  949. <dl class="py function">

  950. <dt class="sig sig-object py" id="curses.wrapper">

  951. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">wrapper</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.wrapper" title="Link to this definition">¶</a></dt>

  952. <dd><p>Initialize curses and call another callable object, <em>func</em>, which should be the

  953. rest of your curses-using application.  If the application raises an exception,

  954. this function will restore the terminal to a sane state before re-raising the

  955. exception and generating a traceback.  The callable object <em>func</em> is then passed

  956. the main window ‘stdscr’ as its first argument, followed by any other arguments

  957. 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

  958. cbreak mode, turns off echo, enables the terminal keypad, and initializes colors

  959. if the terminal has color support.  On exit (whether normally or by exception)

  960. it restores cooked mode, turns on echo, and disables the terminal keypad.</p>

  961. </dd></dl>

  962. 

  963. </section>

  964. <section id="window-objects">

  965. <span id="curses-window-objects"></span><h2>Window Objects<a class="headerlink" href="#window-objects" title="Link to this heading">¶</a></h2>

  966. <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

  967. the following methods and attributes:</p>

  968. <dl class="py method">

  969. <dt class="sig sig-object py" id="curses.window.addch">

  970. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">addch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ch</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">attr</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.addch" title="Link to this definition">¶</a></dt>

  971. <dt class="sig sig-object py">

  972. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">addch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ch</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">attr</span></span></em><span class="optional">]</span><span class="sig-paren">)</span></dt>

  973. <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

  974. character previously painted at that location.  By default, the character

  975. position and attributes are the current settings for the window object.</p>

  976. <div class="admonition note">

  977. <p class="admonition-title">Note</p>

  978. <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>.

  979. Attempting to write to the lower right corner of a window, subwindow,

  980. or pad will cause an exception to be raised after the character is printed.</p>

  981. </div>

  982. </dd></dl>

  983. 

  984. <dl class="py method">

  985. <dt class="sig sig-object py" id="curses.window.addnstr">

  986. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">addnstr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">attr</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.addnstr" title="Link to this definition">¶</a></dt>

  987. <dt class="sig sig-object py">

  988. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">addnstr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">attr</span></span></em><span class="optional">]</span><span class="sig-paren">)</span></dt>

  989. <dd><p>Paint at most <em>n</em> characters of the character string <em>str</em> at

  990. <code class="docutils literal notranslate"><span class="pre">(y,</span> <span class="pre">x)</span></code> with attributes

  991. <em>attr</em>, overwriting anything previously on the display.</p>

  992. </dd></dl>

  993. 

  994. <dl class="py method">

  995. <dt class="sig sig-object py" id="curses.window.addstr">

  996. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">addstr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">str</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">attr</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.addstr" title="Link to this definition">¶</a></dt>

  997. <dt class="sig sig-object py">

  998. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">addstr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">str</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">attr</span></span></em><span class="optional">]</span><span class="sig-paren">)</span></dt>

  999. <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

  1000. <em>attr</em>, overwriting anything previously on the display.</p>

  1001. <div class="admonition note">

  1002. <p class="admonition-title">Note</p>

  1003. <ul class="simple">

  1004. <li><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>.

  1005. Attempting to write to the lower right corner of a window, subwindow,

  1006. or pad will cause an exception to be raised after the string is printed.</p></li>

  1007. <li><p>A <a class="reference external" href="https://bugs.python.org/issue35924">bug in ncurses</a>, the backend

  1008. for this Python module, can cause SegFaults when resizing windows. This

  1009. is fixed in ncurses-6.1-20190511.  If you are stuck with an earlier

  1010. ncurses, you can avoid triggering this if you do not call <a class="reference internal" href="#curses.window.addstr" title="curses.window.addstr"><code class="xref py py-func docutils literal notranslate"><span class="pre">addstr()</span></code></a>

  1011. with a <em>str</em> that has embedded newlines.  Instead, call <a class="reference internal" href="#curses.window.addstr" title="curses.window.addstr"><code class="xref py py-func docutils literal notranslate"><span class="pre">addstr()</span></code></a>

  1012. separately for each line.</p></li>

  1013. </ul>

  1014. </div>

  1015. </dd></dl>

  1016. 

  1017. <dl class="py method">

  1018. <dt class="sig sig-object py" id="curses.window.attroff">

  1019. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">attroff</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">attr</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.attroff" title="Link to this definition">¶</a></dt>

  1020. <dd><p>Remove attribute <em>attr</em> from the “background” set applied to all writes to the

  1021. current window.</p>

  1022. </dd></dl>

  1023. 

  1024. <dl class="py method">

  1025. <dt class="sig sig-object py" id="curses.window.attron">

  1026. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">attron</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">attr</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.attron" title="Link to this definition">¶</a></dt>

  1027. <dd><p>Add attribute <em>attr</em> from the “background” set applied to all writes to the

  1028. current window.</p>

  1029. </dd></dl>

  1030. 

  1031. <dl class="py method">

  1032. <dt class="sig sig-object py" id="curses.window.attrset">

  1033. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">attrset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">attr</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.attrset" title="Link to this definition">¶</a></dt>

  1034. <dd><p>Set the “background” set of attributes to <em>attr</em>.  This set is initially

  1035. <code class="docutils literal notranslate"><span class="pre">0</span></code> (no attributes).</p>

  1036. </dd></dl>

  1037. 

  1038. <dl class="py method">

  1039. <dt class="sig sig-object py" id="curses.window.bkgd">

  1040. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">bkgd</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ch</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">attr</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.bkgd" title="Link to this definition">¶</a></dt>

  1041. <dd><p>Set the background property of the window to the character <em>ch</em>, with

  1042. attributes <em>attr</em>.  The change is then applied to every character position in

  1043. that window:</p>

  1044. <ul class="simple">

  1045. <li><p>The attribute of every character in the window  is changed to the new

  1046. background attribute.</p></li>

  1047. <li><p>Wherever  the  former background character appears, it is changed to the new

  1048. background character.</p></li>

  1049. </ul>

  1050. </dd></dl>

  1051. 

  1052. <dl class="py method">

  1053. <dt class="sig sig-object py" id="curses.window.bkgdset">

  1054. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">bkgdset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ch</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">attr</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.bkgdset" title="Link to this definition">¶</a></dt>

  1055. <dd><p>Set the window’s background.  A window’s background consists of a character and

  1056. any combination of attributes.  The attribute part of the background is combined

  1057. (OR’ed) with all non-blank characters that are written into the window.  Both

  1058. the character and attribute parts of the background are combined with the blank

  1059. characters.  The background becomes a property of the character and moves with

  1060. the character through any scrolling and insert/delete line/character operations.</p>

  1061. </dd></dl>

  1062. 

  1063. <dl class="py method">

  1064. <dt class="sig sig-object py" id="curses.window.border">

  1065. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">border</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="n"><span class="pre">ls</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">rs</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">ts</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">bs</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">tl</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">tr</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">bl</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">br</span></span></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="Link to this definition">¶</a></dt>

  1066. <dd><p>Draw a border around the edges of the window. Each parameter specifies  the

  1067. character to use for a specific part of the border; see the table below for more

  1068. details.</p>

  1069. <div class="admonition note">

  1070. <p class="admonition-title">Note</p>

  1071. <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

  1072. that parameter.  Keyword parameters can <em>not</em> be used.  The defaults are listed

  1073. in this table:</p>

  1074. </div>

  1075. <table class="docutils align-default">

  1076. <thead>

  1077. <tr class="row-odd"><th class="head"><p>Parameter</p></th>

  1078. <th class="head"><p>Description</p></th>

  1079. <th class="head"><p>Default value</p></th>

  1080. </tr>

  1081. </thead>

  1082. <tbody>

  1083. <tr class="row-even"><td><p><em>ls</em></p></td>

  1084. <td><p>Left side</p></td>

  1085. <td><p><a class="reference internal" href="#curses.ACS_VLINE" title="curses.ACS_VLINE"><code class="xref py py-const docutils literal notranslate"><span class="pre">ACS_VLINE</span></code></a></p></td>

  1086. </tr>

  1087. <tr class="row-odd"><td><p><em>rs</em></p></td>

  1088. <td><p>Right side</p></td>

  1089. <td><p><a class="reference internal" href="#curses.ACS_VLINE" title="curses.ACS_VLINE"><code class="xref py py-const docutils literal notranslate"><span class="pre">ACS_VLINE</span></code></a></p></td>

  1090. </tr>

  1091. <tr class="row-even"><td><p><em>ts</em></p></td>

  1092. <td><p>Top</p></td>

  1093. <td><p><a class="reference internal" href="#curses.ACS_HLINE" title="curses.ACS_HLINE"><code class="xref py py-const docutils literal notranslate"><span class="pre">ACS_HLINE</span></code></a></p></td>

  1094. </tr>

  1095. <tr class="row-odd"><td><p><em>bs</em></p></td>

  1096. <td><p>Bottom</p></td>

  1097. <td><p><a class="reference internal" href="#curses.ACS_HLINE" title="curses.ACS_HLINE"><code class="xref py py-const docutils literal notranslate"><span class="pre">ACS_HLINE</span></code></a></p></td>

  1098. </tr>

  1099. <tr class="row-even"><td><p><em>tl</em></p></td>

  1100. <td><p>Upper-left corner</p></td>

  1101. <td><p><a class="reference internal" href="#curses.ACS_ULCORNER" title="curses.ACS_ULCORNER"><code class="xref py py-const docutils literal notranslate"><span class="pre">ACS_ULCORNER</span></code></a></p></td>

  1102. </tr>

  1103. <tr class="row-odd"><td><p><em>tr</em></p></td>

  1104. <td><p>Upper-right corner</p></td>

  1105. <td><p><a class="reference internal" href="#curses.ACS_URCORNER" title="curses.ACS_URCORNER"><code class="xref py py-const docutils literal notranslate"><span class="pre">ACS_URCORNER</span></code></a></p></td>

  1106. </tr>

  1107. <tr class="row-even"><td><p><em>bl</em></p></td>

  1108. <td><p>Bottom-left corner</p></td>

  1109. <td><p><a class="reference internal" href="#curses.ACS_LLCORNER" title="curses.ACS_LLCORNER"><code class="xref py py-const docutils literal notranslate"><span class="pre">ACS_LLCORNER</span></code></a></p></td>

  1110. </tr>

  1111. <tr class="row-odd"><td><p><em>br</em></p></td>

  1112. <td><p>Bottom-right corner</p></td>

  1113. <td><p><a class="reference internal" href="#curses.ACS_LRCORNER" title="curses.ACS_LRCORNER"><code class="xref py py-const docutils literal notranslate"><span class="pre">ACS_LRCORNER</span></code></a></p></td>

  1114. </tr>

  1115. </tbody>

  1116. </table>

  1117. </dd></dl>

  1118. 

  1119. <dl class="py method">

  1120. <dt class="sig sig-object py" id="curses.window.box">

  1121. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">box</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="n"><span class="pre">vertch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">horch</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.box" title="Link to this definition">¶</a></dt>

  1122. <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

  1123. <em>bs</em> are <em>horch</em>.  The default corner characters are always used by this function.</p>

  1124. </dd></dl>

  1125. 

  1126. <dl class="py method">

  1127. <dt class="sig sig-object py" id="curses.window.chgat">

  1128. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">chgat</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">attr</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.chgat" title="Link to this definition">¶</a></dt>

  1129. <dt class="sig sig-object py">

  1130. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">chgat</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attr</span></span></em><span class="sig-paren">)</span></dt>

  1131. <dt class="sig sig-object py">

  1132. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">chgat</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attr</span></span></em><span class="sig-paren">)</span></dt>

  1133. <dt class="sig sig-object py">

  1134. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">chgat</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attr</span></span></em><span class="sig-paren">)</span></dt>

  1135. <dd><p>Set the attributes of <em>num</em> characters at the current cursor position, or at

  1136. 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>,

  1137. the attribute will be set on all the characters to the end of the line.  This

  1138. 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

  1139. 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

  1140. be redisplayed by the next window refresh.</p>

  1141. </dd></dl>

  1142. 

  1143. <dl class="py method">

  1144. <dt class="sig sig-object py" id="curses.window.clear">

  1145. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.clear" title="Link to this definition">¶</a></dt>

  1146. <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

  1147. 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>

  1148. </dd></dl>

  1149. 

  1150. <dl class="py method">

  1151. <dt class="sig sig-object py" id="curses.window.clearok">

  1152. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">clearok</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flag</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.clearok" title="Link to this definition">¶</a></dt>

  1153. <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

  1154. completely.</p>

  1155. </dd></dl>

  1156. 

  1157. <dl class="py method">

  1158. <dt class="sig sig-object py" id="curses.window.clrtobot">

  1159. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">clrtobot</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.clrtobot" title="Link to this definition">¶</a></dt>

  1160. <dd><p>Erase from cursor to the end of the window: all lines below the cursor are

  1161. 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>

  1162. </dd></dl>

  1163. 

  1164. <dl class="py method">

  1165. <dt class="sig sig-object py" id="curses.window.clrtoeol">

  1166. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">clrtoeol</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.clrtoeol" title="Link to this definition">¶</a></dt>

  1167. <dd><p>Erase from cursor to the end of the line.</p>

  1168. </dd></dl>

  1169. 

  1170. <dl class="py method">

  1171. <dt class="sig sig-object py" id="curses.window.cursyncup">

  1172. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">cursyncup</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.cursyncup" title="Link to this definition">¶</a></dt>

  1173. <dd><p>Update the current cursor position of all the ancestors of the window to

  1174. reflect the current cursor position of the window.</p>

  1175. </dd></dl>

  1176. 

  1177. <dl class="py method">

  1178. <dt class="sig sig-object py" id="curses.window.delch">

  1179. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">delch</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.delch" title="Link to this definition">¶</a></dt>

  1180. <dd><p>Delete any character at <code class="docutils literal notranslate"><span class="pre">(y,</span> <span class="pre">x)</span></code>.</p>

  1181. </dd></dl>

  1182. 

  1183. <dl class="py method">

  1184. <dt class="sig sig-object py" id="curses.window.deleteln">

  1185. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">deleteln</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.deleteln" title="Link to this definition">¶</a></dt>

  1186. <dd><p>Delete the line under the cursor. All following lines are moved up by one line.</p>

  1187. </dd></dl>

  1188. 

  1189. <dl class="py method">

  1190. <dt class="sig sig-object py" id="curses.window.derwin">

  1191. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">derwin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">begin_y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">begin_x</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.derwin" title="Link to this definition">¶</a></dt>

  1192. <dt class="sig sig-object py">

  1193. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">derwin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nlines</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ncols</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">begin_y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">begin_x</span></span></em><span class="sig-paren">)</span></dt>

  1194. <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

  1195. <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

  1196. of the window, rather than relative to the entire screen.  Return a window

  1197. object for the derived window.</p>

  1198. </dd></dl>

  1199. 

  1200. <dl class="py method">

  1201. <dt class="sig sig-object py" id="curses.window.echochar">

  1202. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">echochar</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ch</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">attr</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.echochar" title="Link to this definition">¶</a></dt>

  1203. <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>

  1204. on the window.</p>

  1205. </dd></dl>

  1206. 

  1207. <dl class="py method">

  1208. <dt class="sig sig-object py" id="curses.window.enclose">

  1209. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">enclose</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.enclose" title="Link to this definition">¶</a></dt>

  1210. <dd><p>Test whether the given pair of screen-relative character-cell coordinates are

  1211. 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

  1212. determining what subset of the screen windows enclose the location of a mouse

  1213. event.</p>

  1214. <div class="versionchanged">

  1215. <p><span class="versionmodified changed">Changed in version 3.10: </span>Previously it returned <code class="docutils literal notranslate"><span class="pre">1</span></code> or <code class="docutils literal notranslate"><span class="pre">0</span></code> instead of <code class="docutils literal notranslate"><span class="pre">True</span></code> or <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>

  1216. </div>

  1217. </dd></dl>

  1218. 

  1219. <dl class="py attribute">

  1220. <dt class="sig sig-object py" id="curses.window.encoding">

  1221. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">encoding</span></span><a class="headerlink" href="#curses.window.encoding" title="Link to this definition">¶</a></dt>

  1222. <dd><p>Encoding used to encode method arguments (Unicode strings and characters).

  1223. The encoding attribute is inherited from the parent window when a subwindow

  1224. 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>.

  1225. By default, current locale encoding is used (see <a class="reference internal" href="locale.html#locale.getencoding" title="locale.getencoding"><code class="xref py py-func docutils literal notranslate"><span class="pre">locale.getencoding()</span></code></a>).</p>

  1226. <div class="versionadded">

  1227. <p><span class="versionmodified added">New in version 3.3.</span></p>

  1228. </div>

  1229. </dd></dl>

  1230. 

  1231. <dl class="py method">

  1232. <dt class="sig sig-object py" id="curses.window.erase">

  1233. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">erase</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.erase" title="Link to this definition">¶</a></dt>

  1234. <dd><p>Clear the window.</p>

  1235. </dd></dl>

  1236. 

  1237. <dl class="py method">

  1238. <dt class="sig sig-object py" id="curses.window.getbegyx">

  1239. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">getbegyx</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.getbegyx" title="Link to this definition">¶</a></dt>

  1240. <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>

  1241. </dd></dl>

  1242. 

  1243. <dl class="py method">

  1244. <dt class="sig sig-object py" id="curses.window.getbkgd">

  1245. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">getbkgd</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.getbkgd" title="Link to this definition">¶</a></dt>

  1246. <dd><p>Return the given window’s current background character/attribute pair.</p>

  1247. </dd></dl>

  1248. 

  1249. <dl class="py method">

  1250. <dt class="sig sig-object py" id="curses.window.getch">

  1251. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">getch</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.getch" title="Link to this definition">¶</a></dt>

  1252. <dd><p>Get a character. Note that the integer returned does <em>not</em> have to be in ASCII

  1253. range: function keys, keypad keys and so on are represented by numbers higher

  1254. than 255.  In no-delay mode, return <code class="docutils literal notranslate"><span class="pre">-1</span></code> if there is no input, otherwise

  1255. wait until a key is pressed.</p>

  1256. </dd></dl>

  1257. 

  1258. <dl class="py method">

  1259. <dt class="sig sig-object py" id="curses.window.get_wch">

  1260. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">get_wch</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.get_wch" title="Link to this definition">¶</a></dt>

  1261. <dd><p>Get a wide character. Return a character for most keys, or an integer for

  1262. function keys, keypad keys, and other special keys.

  1263. In no-delay mode, raise an exception if there is no input.</p>

  1264. <div class="versionadded">

  1265. <p><span class="versionmodified added">New in version 3.3.</span></p>

  1266. </div>

  1267. </dd></dl>

  1268. 

  1269. <dl class="py method">

  1270. <dt class="sig sig-object py" id="curses.window.getkey">

  1271. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">getkey</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.getkey" title="Link to this definition">¶</a></dt>

  1272. <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>

  1273. does. Function keys, keypad keys and other special keys return a multibyte

  1274. string containing the key name.  In no-delay mode, raise an exception if

  1275. there is no input.</p>

  1276. </dd></dl>

  1277. 

  1278. <dl class="py method">

  1279. <dt class="sig sig-object py" id="curses.window.getmaxyx">

  1280. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">getmaxyx</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.getmaxyx" title="Link to this definition">¶</a></dt>

  1281. <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>

  1282. </dd></dl>

  1283. 

  1284. <dl class="py method">

  1285. <dt class="sig sig-object py" id="curses.window.getparyx">

  1286. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">getparyx</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.getparyx" title="Link to this definition">¶</a></dt>

  1287. <dd><p>Return the beginning coordinates of this window relative to its parent window

  1288. 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

  1289. parent.</p>

  1290. </dd></dl>

  1291. 

  1292. <dl class="py method">

  1293. <dt class="sig sig-object py" id="curses.window.getstr">

  1294. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">getstr</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.getstr" title="Link to this definition">¶</a></dt>

  1295. <dt class="sig sig-object py">

  1296. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">getstr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span></em><span class="sig-paren">)</span></dt>

  1297. <dt class="sig sig-object py">

  1298. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">getstr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em><span class="sig-paren">)</span></dt>

  1299. <dt class="sig sig-object py">

  1300. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">getstr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n</span></span></em><span class="sig-paren">)</span></dt>

  1301. <dd><p>Read a bytes object from the user, with primitive line editing capacity.</p>

  1302. </dd></dl>

  1303. 

  1304. <dl class="py method">

  1305. <dt class="sig sig-object py" id="curses.window.getyx">

  1306. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">getyx</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.getyx" title="Link to this definition">¶</a></dt>

  1307. <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

  1308. upper-left corner.</p>

  1309. </dd></dl>

  1310. 

  1311. <dl class="py method">

  1312. <dt class="sig sig-object py" id="curses.window.hline">

  1313. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">hline</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.hline" title="Link to this definition">¶</a></dt>

  1314. <dt class="sig sig-object py">

  1315. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">hline</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n</span></span></em><span class="sig-paren">)</span></dt>

  1316. <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

  1317. the character <em>ch</em>.</p>

  1318. </dd></dl>

  1319. 

  1320. <dl class="py method">

  1321. <dt class="sig sig-object py" id="curses.window.idcok">

  1322. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">idcok</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flag</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.idcok" title="Link to this definition">¶</a></dt>

  1323. <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

  1324. 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

  1325. and deletion is enabled.  When curses is first initialized, use of character

  1326. insert/delete is enabled by default.</p>

  1327. </dd></dl>

  1328. 

  1329. <dl class="py method">

  1330. <dt class="sig sig-object py" id="curses.window.idlok">

  1331. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">idlok</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flag</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.idlok" title="Link to this definition">¶</a></dt>

  1332. <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

  1333. editing facilities. Otherwise, line insertion/deletion are disabled.</p>

  1334. </dd></dl>

  1335. 

  1336. <dl class="py method">

  1337. <dt class="sig sig-object py" id="curses.window.immedok">

  1338. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">immedok</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flag</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.immedok" title="Link to this definition">¶</a></dt>

  1339. <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

  1340. 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.

  1341. However, it may degrade performance considerably, due to repeated calls to

  1342. wrefresh.  This option is disabled by default.</p>

  1343. </dd></dl>

  1344. 

  1345. <dl class="py method">

  1346. <dt class="sig sig-object py" id="curses.window.inch">

  1347. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">inch</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.inch" title="Link to this definition">¶</a></dt>

  1348. <dd><p>Return the character at the given position in the window. The bottom 8 bits are

  1349. the character proper, and upper bits are the attributes.</p>

  1350. </dd></dl>

  1351. 

  1352. <dl class="py method">

  1353. <dt class="sig sig-object py" id="curses.window.insch">

  1354. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">insch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ch</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">attr</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.insch" title="Link to this definition">¶</a></dt>

  1355. <dt class="sig sig-object py">

  1356. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">insch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ch</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">attr</span></span></em><span class="optional">]</span><span class="sig-paren">)</span></dt>

  1357. <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

  1358. position <em>x</em> right by one character.</p>

  1359. </dd></dl>

  1360. 

  1361. <dl class="py method">

  1362. <dt class="sig sig-object py" id="curses.window.insdelln">

  1363. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">insdelln</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nlines</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.insdelln" title="Link to this definition">¶</a></dt>

  1364. <dd><p>Insert <em>nlines</em> lines into the specified window above the current line.  The

  1365. <em>nlines</em> bottom lines are lost.  For negative <em>nlines</em>, delete <em>nlines</em> lines

  1366. starting with the one under the cursor, and move the remaining lines up.  The

  1367. bottom <em>nlines</em> lines are cleared.  The current cursor position remains the

  1368. same.</p>

  1369. </dd></dl>

  1370. 

  1371. <dl class="py method">

  1372. <dt class="sig sig-object py" id="curses.window.insertln">

  1373. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">insertln</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.insertln" title="Link to this definition">¶</a></dt>

  1374. <dd><p>Insert a blank line under the cursor. All following lines are moved down by one

  1375. line.</p>

  1376. </dd></dl>

  1377. 

  1378. <dl class="py method">

  1379. <dt class="sig sig-object py" id="curses.window.insnstr">

  1380. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">insnstr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">attr</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.insnstr" title="Link to this definition">¶</a></dt>

  1381. <dt class="sig sig-object py">

  1382. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">insnstr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">attr</span></span></em><span class="optional">]</span><span class="sig-paren">)</span></dt>

  1383. <dd><p>Insert a character string (as many characters as will fit on the line) before

  1384. the character under the cursor, up to <em>n</em> characters.   If <em>n</em> is zero or

  1385. negative, the entire string is inserted. All characters to the right of the

  1386. cursor are shifted right, with the rightmost characters on the line being lost.

  1387. The cursor position does not change (after moving to <em>y</em>, <em>x</em>, if specified).</p>

  1388. </dd></dl>

  1389. 

  1390. <dl class="py method">

  1391. <dt class="sig sig-object py" id="curses.window.insstr">

  1392. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">insstr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">str</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">attr</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.insstr" title="Link to this definition">¶</a></dt>

  1393. <dt class="sig sig-object py">

  1394. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">insstr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">str</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">attr</span></span></em><span class="optional">]</span><span class="sig-paren">)</span></dt>

  1395. <dd><p>Insert a character string (as many characters as will fit on the line) before

  1396. the character under the cursor.  All characters to the right of the cursor are

  1397. shifted right, with the rightmost characters on the line being lost.  The cursor

  1398. position does not change (after moving to <em>y</em>, <em>x</em>, if specified).</p>

  1399. </dd></dl>

  1400. 

  1401. <dl class="py method">

  1402. <dt class="sig sig-object py" id="curses.window.instr">

  1403. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">instr</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="n"><span class="pre">n</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.instr" title="Link to this definition">¶</a></dt>

  1404. <dt class="sig sig-object py">

  1405. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">instr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">n</span></span></em><span class="optional">]</span><span class="sig-paren">)</span></dt>

  1406. <dd><p>Return a bytes object of characters, extracted from the window starting at the

  1407. current cursor position, or at <em>y</em>, <em>x</em> if specified. Attributes are stripped

  1408. 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

  1409. at most <em>n</em> characters long (exclusive of the trailing NUL).</p>

  1410. </dd></dl>

  1411. 

  1412. <dl class="py method">

  1413. <dt class="sig sig-object py" id="curses.window.is_linetouched">

  1414. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">is_linetouched</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">line</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.is_linetouched" title="Link to this definition">¶</a></dt>

  1415. <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

  1416. <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>

  1417. exception if <em>line</em> is not valid for the given window.</p>

  1418. </dd></dl>

  1419. 

  1420. <dl class="py method">

  1421. <dt class="sig sig-object py" id="curses.window.is_wintouched">

  1422. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">is_wintouched</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.is_wintouched" title="Link to this definition">¶</a></dt>

  1423. <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

  1424. <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>

  1425. </dd></dl>

  1426. 

  1427. <dl class="py method">

  1428. <dt class="sig sig-object py" id="curses.window.keypad">

  1429. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">keypad</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flag</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.keypad" title="Link to this definition">¶</a></dt>

  1430. <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)

  1431. 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

  1432. left as is in the input stream.</p>

  1433. </dd></dl>

  1434. 

  1435. <dl class="py method">

  1436. <dt class="sig sig-object py" id="curses.window.leaveok">

  1437. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">leaveok</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flag</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.leaveok" title="Link to this definition">¶</a></dt>

  1438. <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

  1439. position.”  This reduces cursor movement where possible. If possible the cursor

  1440. will be made invisible.</p>

  1441. <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>

  1442. </dd></dl>

  1443. 

  1444. <dl class="py method">

  1445. <dt class="sig sig-object py" id="curses.window.move">

  1446. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">move</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">new_y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new_x</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.move" title="Link to this definition">¶</a></dt>

  1447. <dd><p>Move cursor to <code class="docutils literal notranslate"><span class="pre">(new_y,</span> <span class="pre">new_x)</span></code>.</p>

  1448. </dd></dl>

  1449. 

  1450. <dl class="py method">

  1451. <dt class="sig sig-object py" id="curses.window.mvderwin">

  1452. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">mvderwin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.mvderwin" title="Link to this definition">¶</a></dt>

  1453. <dd><p>Move the window inside its parent window.  The screen-relative parameters of

  1454. the window are not changed.  This routine is used to display different parts of

  1455. the parent window at the same physical position on the screen.</p>

  1456. </dd></dl>

  1457. 

  1458. <dl class="py method">

  1459. <dt class="sig sig-object py" id="curses.window.mvwin">

  1460. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">mvwin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">new_y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new_x</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.mvwin" title="Link to this definition">¶</a></dt>

  1461. <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>

  1462. </dd></dl>

  1463. 

  1464. <dl class="py method">

  1465. <dt class="sig sig-object py" id="curses.window.nodelay">

  1466. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">nodelay</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flag</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.nodelay" title="Link to this definition">¶</a></dt>

  1467. <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>

  1468. </dd></dl>

  1469. 

  1470. <dl class="py method">

  1471. <dt class="sig sig-object py" id="curses.window.notimeout">

  1472. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">notimeout</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flag</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.notimeout" title="Link to this definition">¶</a></dt>

  1473. <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>

  1474. <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

  1475. interpreted, and will be left in the input stream as is.</p>

  1476. </dd></dl>

  1477. 

  1478. <dl class="py method">

  1479. <dt class="sig sig-object py" id="curses.window.noutrefresh">

  1480. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">noutrefresh</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.noutrefresh" title="Link to this definition">¶</a></dt>

  1481. <dd><p>Mark for refresh but wait.  This function updates the data structure

  1482. representing the desired state of the window, but does not force an update of

  1483. 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>

  1484. </dd></dl>

  1485. 

  1486. <dl class="py method">

  1487. <dt class="sig sig-object py" id="curses.window.overlay">

  1488. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">overlay</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">destwin</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">sminrow</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">smincol</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dminrow</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dmincol</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dmaxrow</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dmaxcol</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.overlay" title="Link to this definition">¶</a></dt>

  1489. <dd><p>Overlay the window on top of <em>destwin</em>. The windows need not be the same size,

  1490. only the overlapping region is copied. This copy is non-destructive, which means

  1491. that the current background character does not overwrite the old contents of

  1492. <em>destwin</em>.</p>

  1493. <p>To get fine-grained control over the copied region, the second form of

  1494. <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

  1495. coordinates of the source window, and the other variables mark a rectangle in

  1496. the destination window.</p>

  1497. </dd></dl>

  1498. 

  1499. <dl class="py method">

  1500. <dt class="sig sig-object py" id="curses.window.overwrite">

  1501. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">overwrite</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">destwin</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">sminrow</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">smincol</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dminrow</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dmincol</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dmaxrow</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dmaxcol</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.overwrite" title="Link to this definition">¶</a></dt>

  1502. <dd><p>Overwrite the window on top of <em>destwin</em>. The windows need not be the same size,

  1503. in which case only the overlapping region is copied. This copy is destructive,

  1504. which means that the current background character overwrites the old contents of

  1505. <em>destwin</em>.</p>

  1506. <p>To get fine-grained control over the copied region, the second form of

  1507. <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

  1508. coordinates of the source window, the other variables mark a rectangle in the

  1509. destination window.</p>

  1510. </dd></dl>

  1511. 

  1512. <dl class="py method">

  1513. <dt class="sig sig-object py" id="curses.window.putwin">

  1514. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">putwin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.putwin" title="Link to this definition">¶</a></dt>

  1515. <dd><p>Write all data associated with the window into the provided file object.  This

  1516. 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>

  1517. </dd></dl>

  1518. 

  1519. <dl class="py method">

  1520. <dt class="sig sig-object py" id="curses.window.redrawln">

  1521. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">redrawln</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">beg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.redrawln" title="Link to this definition">¶</a></dt>

  1522. <dd><p>Indicate that the <em>num</em> screen lines, starting at line <em>beg</em>, are corrupted and

  1523. 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>

  1524. </dd></dl>

  1525. 

  1526. <dl class="py method">

  1527. <dt class="sig sig-object py" id="curses.window.redrawwin">

  1528. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">redrawwin</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.redrawwin" title="Link to this definition">¶</a></dt>

  1529. <dd><p>Touch the entire window, causing it to be completely redrawn on the next

  1530. <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>

  1531. </dd></dl>

  1532. 

  1533. <dl class="py method">

  1534. <dt class="sig sig-object py" id="curses.window.refresh">

  1535. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">refresh</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="n"><span class="pre">pminrow</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pmincol</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sminrow</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">smincol</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">smaxrow</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">smaxcol</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.refresh" title="Link to this definition">¶</a></dt>

  1536. <dd><p>Update the display immediately (sync actual screen with previous

  1537. drawing/deleting methods).</p>

  1538. <p>The 6 optional arguments can only be specified when the window is a pad created

  1539. 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

  1540. of the pad and screen are involved. <em>pminrow</em> and <em>pmincol</em> specify the upper

  1541. left-hand corner of the rectangle to be displayed in the pad.  <em>sminrow</em>,

  1542. <em>smincol</em>, <em>smaxrow</em>, and <em>smaxcol</em> specify the edges of the rectangle to be

  1543. displayed on the screen.  The lower right-hand corner of the rectangle to be

  1544. displayed in the pad is calculated from the screen coordinates, since the

  1545. rectangles must be the same size.  Both rectangles must be entirely contained

  1546. within their respective structures.  Negative values of <em>pminrow</em>, <em>pmincol</em>,

  1547. <em>sminrow</em>, or <em>smincol</em> are treated as if they were zero.</p>

  1548. </dd></dl>

  1549. 

  1550. <dl class="py method">

  1551. <dt class="sig sig-object py" id="curses.window.resize">

  1552. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">resize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nlines</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ncols</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.resize" title="Link to this definition">¶</a></dt>

  1553. <dd><p>Reallocate storage for a curses window to adjust its dimensions to the

  1554. specified values.  If either dimension is larger than the current values, the

  1555. window’s data is filled with blanks that have the current background

  1556. 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>

  1557. </dd></dl>

  1558. 

  1559. <dl class="py method">

  1560. <dt class="sig sig-object py" id="curses.window.scroll">

  1561. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">scroll</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="n"><span class="pre">lines=1</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.scroll" title="Link to this definition">¶</a></dt>

  1562. <dd><p>Scroll the screen or scrolling region upward by <em>lines</em> lines.</p>

  1563. </dd></dl>

  1564. 

  1565. <dl class="py method">

  1566. <dt class="sig sig-object py" id="curses.window.scrollok">

  1567. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">scrollok</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flag</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.scrollok" title="Link to this definition">¶</a></dt>

  1568. <dd><p>Control what happens when the cursor of a window is moved off the edge of the

  1569. window or scrolling region, either as a result of a newline action on the bottom

  1570. 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

  1571. 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

  1572. one line.  Note that in order to get the physical scrolling effect on the

  1573. 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>

  1574. </dd></dl>

  1575. 

  1576. <dl class="py method">

  1577. <dt class="sig sig-object py" id="curses.window.setscrreg">

  1578. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">setscrreg</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">top</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bottom</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.setscrreg" title="Link to this definition">¶</a></dt>

  1579. <dd><p>Set the scrolling region from line <em>top</em> to line <em>bottom</em>. All scrolling actions

  1580. will take place in this region.</p>

  1581. </dd></dl>

  1582. 

  1583. <dl class="py method">

  1584. <dt class="sig sig-object py" id="curses.window.standend">

  1585. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">standend</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.standend" title="Link to this definition">¶</a></dt>

  1586. <dd><p>Turn off the standout attribute.  On some terminals this has the side effect of

  1587. turning off all attributes.</p>

  1588. </dd></dl>

  1589. 

  1590. <dl class="py method">

  1591. <dt class="sig sig-object py" id="curses.window.standout">

  1592. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">standout</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.standout" title="Link to this definition">¶</a></dt>

  1593. <dd><p>Turn on attribute <em>A_STANDOUT</em>.</p>

  1594. </dd></dl>

  1595. 

  1596. <dl class="py method">

  1597. <dt class="sig sig-object py" id="curses.window.subpad">

  1598. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">subpad</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">begin_y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">begin_x</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.subpad" title="Link to this definition">¶</a></dt>

  1599. <dt class="sig sig-object py">

  1600. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">subpad</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nlines</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ncols</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">begin_y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">begin_x</span></span></em><span class="sig-paren">)</span></dt>

  1601. <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

  1602. whose width/height is <em>ncols</em>/<em>nlines</em>.</p>

  1603. </dd></dl>

  1604. 

  1605. <dl class="py method">

  1606. <dt class="sig sig-object py" id="curses.window.subwin">

  1607. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">subwin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">begin_y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">begin_x</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.subwin" title="Link to this definition">¶</a></dt>

  1608. <dt class="sig sig-object py">

  1609. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">subwin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nlines</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ncols</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">begin_y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">begin_x</span></span></em><span class="sig-paren">)</span></dt>

  1610. <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

  1611. whose width/height is <em>ncols</em>/<em>nlines</em>.</p>

  1612. <p>By default, the sub-window will extend from the specified position to the lower

  1613. right corner of the window.</p>

  1614. </dd></dl>

  1615. 

  1616. <dl class="py method">

  1617. <dt class="sig sig-object py" id="curses.window.syncdown">

  1618. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">syncdown</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.syncdown" title="Link to this definition">¶</a></dt>

  1619. <dd><p>Touch each location in the window that has been touched in any of its ancestor

  1620. 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

  1621. be necessary to call it manually.</p>

  1622. </dd></dl>

  1623. 

  1624. <dl class="py method">

  1625. <dt class="sig sig-object py" id="curses.window.syncok">

  1626. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">syncok</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flag</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.syncok" title="Link to this definition">¶</a></dt>

  1627. <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

  1628. whenever there is a change in the window.</p>

  1629. </dd></dl>

  1630. 

  1631. <dl class="py method">

  1632. <dt class="sig sig-object py" id="curses.window.syncup">

  1633. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">syncup</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.syncup" title="Link to this definition">¶</a></dt>

  1634. <dd><p>Touch all locations in ancestors of the window that have been changed in  the

  1635. window.</p>

  1636. </dd></dl>

  1637. 

  1638. <dl class="py method">

  1639. <dt class="sig sig-object py" id="curses.window.timeout">

  1640. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">timeout</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">delay</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.timeout" title="Link to this definition">¶</a></dt>

  1641. <dd><p>Set blocking or non-blocking read behavior for the window.  If <em>delay</em> is

  1642. negative, blocking read is used (which will wait indefinitely for input).  If

  1643. <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

  1644. return <code class="docutils literal notranslate"><span class="pre">-1</span></code> if no input is waiting.  If <em>delay</em> is positive, then

  1645. <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

  1646. still no input at the end of that time.</p>

  1647. </dd></dl>

  1648. 

  1649. <dl class="py method">

  1650. <dt class="sig sig-object py" id="curses.window.touchline">

  1651. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">touchline</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">start</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">count</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">changed</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.touchline" title="Link to this definition">¶</a></dt>

  1652. <dd><p>Pretend <em>count</em> lines have been changed, starting with line <em>start</em>.  If

  1653. <em>changed</em> is supplied, it specifies whether the affected lines are marked as

  1654. 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>

  1655. </dd></dl>

  1656. 

  1657. <dl class="py method">

  1658. <dt class="sig sig-object py" id="curses.window.touchwin">

  1659. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">touchwin</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.touchwin" title="Link to this definition">¶</a></dt>

  1660. <dd><p>Pretend the whole window has been changed, for purposes of drawing

  1661. optimizations.</p>

  1662. </dd></dl>

  1663. 

  1664. <dl class="py method">

  1665. <dt class="sig sig-object py" id="curses.window.untouchwin">

  1666. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">untouchwin</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.untouchwin" title="Link to this definition">¶</a></dt>

  1667. <dd><p>Mark all lines in  the  window  as unchanged since the last call to

  1668. <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>

  1669. </dd></dl>

  1670. 

  1671. <dl class="py method">

  1672. <dt class="sig sig-object py" id="curses.window.vline">

  1673. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">vline</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">attr</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.window.vline" title="Link to this definition">¶</a></dt>

  1674. <dt class="sig sig-object py">

  1675. <span class="sig-prename descclassname"><span class="pre">window.</span></span><span class="sig-name descname"><span class="pre">vline</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">attr</span></span></em><span class="optional">]</span><span class="sig-paren">)</span></dt>

  1676. <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

  1677. character <em>ch</em> with attributes <em>attr</em>.</p>

  1678. </dd></dl>

  1679. 

  1680. </section>

  1681. <section id="constants">

  1682. <h2>Constants<a class="headerlink" href="#constants" title="Link to this heading">¶</a></h2>

  1683. <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>

  1684. <dl class="py data">

  1685. <dt class="sig sig-object py" id="curses.ERR">

  1686. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ERR</span></span><a class="headerlink" href="#curses.ERR" title="Link to this definition">¶</a></dt>

  1687. <dd><p>Some curses routines  that  return  an integer, such 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>, return

  1688. <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>

  1689. </dd></dl>

  1690. 

  1691. <dl class="py data">

  1692. <dt class="sig sig-object py" id="curses.OK">

  1693. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">OK</span></span><a class="headerlink" href="#curses.OK" title="Link to this definition">¶</a></dt>

  1694. <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

  1695. <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>

  1696. </dd></dl>

  1697. 

  1698. <dl class="py data">

  1699. <dt class="sig sig-object py" id="curses.version">

  1700. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">version</span></span><a class="headerlink" href="#curses.version" title="Link to this definition">¶</a></dt>

  1701. <dd></dd></dl>

  1702. 

  1703. <dl class="py data">

  1704. <dt class="sig sig-object py" id="curses.__version__">

  1705. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">__version__</span></span><a class="headerlink" href="#curses.__version__" title="Link to this definition">¶</a></dt>

  1706. <dd><p>A bytes object representing the current version of the module.</p>

  1707. </dd></dl>

  1708. 

  1709. <dl class="py data">

  1710. <dt class="sig sig-object py" id="curses.ncurses_version">

  1711. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ncurses_version</span></span><a class="headerlink" href="#curses.ncurses_version" title="Link to this definition">¶</a></dt>

  1712. <dd><p>A named tuple containing the three components of the ncurses library

  1713. version: <em>major</em>, <em>minor</em>, and <em>patch</em>.  All values are integers.  The

  1714. components can also be accessed by name,  so <code class="docutils literal notranslate"><span class="pre">curses.ncurses_version[0]</span></code>

  1715. is equivalent to <code class="docutils literal notranslate"><span class="pre">curses.ncurses_version.major</span></code> and so on.</p>

  1716. <p>Availability: if the ncurses library is used.</p>

  1717. <div class="versionadded">

  1718. <p><span class="versionmodified added">New in version 3.8.</span></p>

  1719. </div>

  1720. </dd></dl>

  1721. 

  1722. <dl class="py data">

  1723. <dt class="sig sig-object py" id="curses.COLORS">

  1724. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">COLORS</span></span><a class="headerlink" href="#curses.COLORS" title="Link to this definition">¶</a></dt>

  1725. <dd><p>The maximum number of colors the terminal can support.

  1726. It is defined only after the call to <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>.</p>

  1727. </dd></dl>

  1728. 

  1729. <dl class="py data">

  1730. <dt class="sig sig-object py" id="curses.COLOR_PAIRS">

  1731. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">COLOR_PAIRS</span></span><a class="headerlink" href="#curses.COLOR_PAIRS" title="Link to this definition">¶</a></dt>

  1732. <dd><p>The maximum number of color pairs the terminal can support.

  1733. It is defined only after the call to <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>.</p>

  1734. </dd></dl>

  1735. 

  1736. <dl class="py data">

  1737. <dt class="sig sig-object py" id="curses.COLS">

  1738. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">COLS</span></span><a class="headerlink" href="#curses.COLS" title="Link to this definition">¶</a></dt>

  1739. <dd><p>The width of the screen, i.e., the number of columns.

  1740. 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>.

  1741. Updated by <a class="reference internal" href="#curses.update_lines_cols" title="curses.update_lines_cols"><code class="xref py py-func docutils literal notranslate"><span class="pre">update_lines_cols()</span></code></a>, <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> and

  1742. <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>.</p>

  1743. </dd></dl>

  1744. 

  1745. <dl class="py data">

  1746. <dt class="sig sig-object py" id="curses.LINES">

  1747. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">LINES</span></span><a class="headerlink" href="#curses.LINES" title="Link to this definition">¶</a></dt>

  1748. <dd><p>The height of the screen, i.e., the number of lines.

  1749. 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>.

  1750. Updated by <a class="reference internal" href="#curses.update_lines_cols" title="curses.update_lines_cols"><code class="xref py py-func docutils literal notranslate"><span class="pre">update_lines_cols()</span></code></a>, <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> and

  1751. <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>.</p>

  1752. </dd></dl>

  1753. 

  1754. <p>Some constants are available to specify character cell attributes.

  1755. The exact constants available are system dependent.</p>

  1756. <table class="docutils align-default">

  1757. <thead>

  1758. <tr class="row-odd"><th class="head"><p>Attribute</p></th>

  1759. <th class="head"><p>Meaning</p></th>

  1760. </tr>

  1761. </thead>

  1762. <tbody>

  1763. <tr class="row-even"><td><dl class="py data">

  1764. <dt class="sig sig-object py" id="curses.A_ALTCHARSET">

  1765. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">A_ALTCHARSET</span></span><a class="headerlink" href="#curses.A_ALTCHARSET" title="Link to this definition">¶</a></dt>

  1766. <dd></dd></dl>

  1767. 

  1768. </td>

  1769. <td><p>Alternate character set mode</p></td>

  1770. </tr>

  1771. <tr class="row-odd"><td><dl class="py data">

  1772. <dt class="sig sig-object py" id="curses.A_BLINK">

  1773. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">A_BLINK</span></span><a class="headerlink" href="#curses.A_BLINK" title="Link to this definition">¶</a></dt>

  1774. <dd></dd></dl>

  1775. 

  1776. </td>

  1777. <td><p>Blink mode</p></td>

  1778. </tr>

  1779. <tr class="row-even"><td><dl class="py data">

  1780. <dt class="sig sig-object py" id="curses.A_BOLD">

  1781. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">A_BOLD</span></span><a class="headerlink" href="#curses.A_BOLD" title="Link to this definition">¶</a></dt>

  1782. <dd></dd></dl>

  1783. 

  1784. </td>

  1785. <td><p>Bold mode</p></td>

  1786. </tr>

  1787. <tr class="row-odd"><td><dl class="py data">

  1788. <dt class="sig sig-object py" id="curses.A_DIM">

  1789. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">A_DIM</span></span><a class="headerlink" href="#curses.A_DIM" title="Link to this definition">¶</a></dt>

  1790. <dd></dd></dl>

  1791. 

  1792. </td>

  1793. <td><p>Dim mode</p></td>

  1794. </tr>

  1795. <tr class="row-even"><td><dl class="py data">

  1796. <dt class="sig sig-object py" id="curses.A_INVIS">

  1797. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">A_INVIS</span></span><a class="headerlink" href="#curses.A_INVIS" title="Link to this definition">¶</a></dt>

  1798. <dd></dd></dl>

  1799. 

  1800. </td>

  1801. <td><p>Invisible or blank mode</p></td>

  1802. </tr>

  1803. <tr class="row-odd"><td><dl class="py data">

  1804. <dt class="sig sig-object py" id="curses.A_ITALIC">

  1805. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">A_ITALIC</span></span><a class="headerlink" href="#curses.A_ITALIC" title="Link to this definition">¶</a></dt>

  1806. <dd></dd></dl>

  1807. 

  1808. </td>

  1809. <td><p>Italic mode</p></td>

  1810. </tr>

  1811. <tr class="row-even"><td><dl class="py data">

  1812. <dt class="sig sig-object py" id="curses.A_NORMAL">

  1813. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">A_NORMAL</span></span><a class="headerlink" href="#curses.A_NORMAL" title="Link to this definition">¶</a></dt>

  1814. <dd></dd></dl>

  1815. 

  1816. </td>

  1817. <td><p>Normal attribute</p></td>

  1818. </tr>

  1819. <tr class="row-odd"><td><dl class="py data">

  1820. <dt class="sig sig-object py" id="curses.A_PROTECT">

  1821. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">A_PROTECT</span></span><a class="headerlink" href="#curses.A_PROTECT" title="Link to this definition">¶</a></dt>

  1822. <dd></dd></dl>

  1823. 

  1824. </td>

  1825. <td><p>Protected mode</p></td>

  1826. </tr>

  1827. <tr class="row-even"><td><dl class="py data">

  1828. <dt class="sig sig-object py" id="curses.A_REVERSE">

  1829. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">A_REVERSE</span></span><a class="headerlink" href="#curses.A_REVERSE" title="Link to this definition">¶</a></dt>

  1830. <dd></dd></dl>

  1831. 

  1832. </td>

  1833. <td><p>Reverse background and

  1834. foreground colors</p></td>

  1835. </tr>

  1836. <tr class="row-odd"><td><dl class="py data">

  1837. <dt class="sig sig-object py" id="curses.A_STANDOUT">

  1838. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">A_STANDOUT</span></span><a class="headerlink" href="#curses.A_STANDOUT" title="Link to this definition">¶</a></dt>

  1839. <dd></dd></dl>

  1840. 

  1841. </td>

  1842. <td><p>Standout mode</p></td>

  1843. </tr>

  1844. <tr class="row-even"><td><dl class="py data">

  1845. <dt class="sig sig-object py" id="curses.A_UNDERLINE">

  1846. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">A_UNDERLINE</span></span><a class="headerlink" href="#curses.A_UNDERLINE" title="Link to this definition">¶</a></dt>

  1847. <dd></dd></dl>

  1848. 

  1849. </td>

  1850. <td><p>Underline mode</p></td>

  1851. </tr>

  1852. <tr class="row-odd"><td><dl class="py data">

  1853. <dt class="sig sig-object py" id="curses.A_HORIZONTAL">

  1854. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">A_HORIZONTAL</span></span><a class="headerlink" href="#curses.A_HORIZONTAL" title="Link to this definition">¶</a></dt>

  1855. <dd></dd></dl>

  1856. 

  1857. </td>

  1858. <td><p>Horizontal highlight</p></td>

  1859. </tr>

  1860. <tr class="row-even"><td><dl class="py data">

  1861. <dt class="sig sig-object py" id="curses.A_LEFT">

  1862. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">A_LEFT</span></span><a class="headerlink" href="#curses.A_LEFT" title="Link to this definition">¶</a></dt>

  1863. <dd></dd></dl>

  1864. 

  1865. </td>

  1866. <td><p>Left highlight</p></td>

  1867. </tr>

  1868. <tr class="row-odd"><td><dl class="py data">

  1869. <dt class="sig sig-object py" id="curses.A_LOW">

  1870. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">A_LOW</span></span><a class="headerlink" href="#curses.A_LOW" title="Link to this definition">¶</a></dt>

  1871. <dd></dd></dl>

  1872. 

  1873. </td>

  1874. <td><p>Low highlight</p></td>

  1875. </tr>

  1876. <tr class="row-even"><td><dl class="py data">

  1877. <dt class="sig sig-object py" id="curses.A_RIGHT">

  1878. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">A_RIGHT</span></span><a class="headerlink" href="#curses.A_RIGHT" title="Link to this definition">¶</a></dt>

  1879. <dd></dd></dl>

  1880. 

  1881. </td>

  1882. <td><p>Right highlight</p></td>

  1883. </tr>

  1884. <tr class="row-odd"><td><dl class="py data">

  1885. <dt class="sig sig-object py" id="curses.A_TOP">

  1886. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">A_TOP</span></span><a class="headerlink" href="#curses.A_TOP" title="Link to this definition">¶</a></dt>

  1887. <dd></dd></dl>

  1888. 

  1889. </td>

  1890. <td><p>Top highlight</p></td>

  1891. </tr>

  1892. <tr class="row-even"><td><dl class="py data">

  1893. <dt class="sig sig-object py" id="curses.A_VERTICAL">

  1894. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">A_VERTICAL</span></span><a class="headerlink" href="#curses.A_VERTICAL" title="Link to this definition">¶</a></dt>

  1895. <dd></dd></dl>

  1896. 

  1897. </td>

  1898. <td><p>Vertical highlight</p></td>

  1899. </tr>

  1900. </tbody>

  1901. </table>

  1902. <div class="versionadded">

  1903. <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>

  1904. </div>

  1905. <p>Several constants are available to extract corresponding attributes returned

  1906. by some methods.</p>

  1907. <table class="docutils align-default">

  1908. <thead>

  1909. <tr class="row-odd"><th class="head"><p>Bit-mask</p></th>

  1910. <th class="head"><p>Meaning</p></th>

  1911. </tr>

  1912. </thead>

  1913. <tbody>

  1914. <tr class="row-even"><td><dl class="py data">

  1915. <dt class="sig sig-object py" id="curses.A_ATTRIBUTES">

  1916. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">A_ATTRIBUTES</span></span><a class="headerlink" href="#curses.A_ATTRIBUTES" title="Link to this definition">¶</a></dt>

  1917. <dd></dd></dl>

  1918. 

  1919. </td>

  1920. <td><p>Bit-mask to extract

  1921. attributes</p></td>

  1922. </tr>

  1923. <tr class="row-odd"><td><dl class="py data">

  1924. <dt class="sig sig-object py" id="curses.A_CHARTEXT">

  1925. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">A_CHARTEXT</span></span><a class="headerlink" href="#curses.A_CHARTEXT" title="Link to this definition">¶</a></dt>

  1926. <dd></dd></dl>

  1927. 

  1928. </td>

  1929. <td><p>Bit-mask to extract a

  1930. character</p></td>

  1931. </tr>

  1932. <tr class="row-even"><td><dl class="py data">

  1933. <dt class="sig sig-object py" id="curses.A_COLOR">

  1934. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">A_COLOR</span></span><a class="headerlink" href="#curses.A_COLOR" title="Link to this definition">¶</a></dt>

  1935. <dd></dd></dl>

  1936. 

  1937. </td>

  1938. <td><p>Bit-mask to extract

  1939. color-pair field information</p></td>

  1940. </tr>

  1941. </tbody>

  1942. </table>

  1943. <p>Keys are referred to by integer constants with names starting with  <code class="docutils literal notranslate"><span class="pre">KEY_</span></code>.

  1944. The exact keycaps available are system dependent.</p>

  1945. <table class="docutils align-default">

  1946. <thead>

  1947. <tr class="row-odd"><th class="head"><p>Key constant</p></th>

  1948. <th class="head"><p>Key</p></th>

  1949. </tr>

  1950. </thead>

  1951. <tbody>

  1952. <tr class="row-even"><td><dl class="py data">

  1953. <dt class="sig sig-object py" id="curses.KEY_MIN">

  1954. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_MIN</span></span><a class="headerlink" href="#curses.KEY_MIN" title="Link to this definition">¶</a></dt>

  1955. <dd></dd></dl>

  1956. 

  1957. </td>

  1958. <td><p>Minimum key value</p></td>

  1959. </tr>

  1960. <tr class="row-odd"><td><dl class="py data">

  1961. <dt class="sig sig-object py" id="curses.KEY_BREAK">

  1962. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_BREAK</span></span><a class="headerlink" href="#curses.KEY_BREAK" title="Link to this definition">¶</a></dt>

  1963. <dd></dd></dl>

  1964. 

  1965. </td>

  1966. <td><p>Break key (unreliable)</p></td>

  1967. </tr>

  1968. <tr class="row-even"><td><dl class="py data">

  1969. <dt class="sig sig-object py" id="curses.KEY_DOWN">

  1970. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_DOWN</span></span><a class="headerlink" href="#curses.KEY_DOWN" title="Link to this definition">¶</a></dt>

  1971. <dd></dd></dl>

  1972. 

  1973. </td>

  1974. <td><p>Down-arrow</p></td>

  1975. </tr>

  1976. <tr class="row-odd"><td><dl class="py data">

  1977. <dt class="sig sig-object py" id="curses.KEY_UP">

  1978. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_UP</span></span><a class="headerlink" href="#curses.KEY_UP" title="Link to this definition">¶</a></dt>

  1979. <dd></dd></dl>

  1980. 

  1981. </td>

  1982. <td><p>Up-arrow</p></td>

  1983. </tr>

  1984. <tr class="row-even"><td><dl class="py data">

  1985. <dt class="sig sig-object py" id="curses.KEY_LEFT">

  1986. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_LEFT</span></span><a class="headerlink" href="#curses.KEY_LEFT" title="Link to this definition">¶</a></dt>

  1987. <dd></dd></dl>

  1988. 

  1989. </td>

  1990. <td><p>Left-arrow</p></td>

  1991. </tr>

  1992. <tr class="row-odd"><td><dl class="py data">

  1993. <dt class="sig sig-object py" id="curses.KEY_RIGHT">

  1994. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_RIGHT</span></span><a class="headerlink" href="#curses.KEY_RIGHT" title="Link to this definition">¶</a></dt>

  1995. <dd></dd></dl>

  1996. 

  1997. </td>

  1998. <td><p>Right-arrow</p></td>

  1999. </tr>

  2000. <tr class="row-even"><td><dl class="py data">

  2001. <dt class="sig sig-object py" id="curses.KEY_HOME">

  2002. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_HOME</span></span><a class="headerlink" href="#curses.KEY_HOME" title="Link to this definition">¶</a></dt>

  2003. <dd></dd></dl>

  2004. 

  2005. </td>

  2006. <td><p>Home key (upward+left arrow)</p></td>

  2007. </tr>

  2008. <tr class="row-odd"><td><dl class="py data">

  2009. <dt class="sig sig-object py" id="curses.KEY_BACKSPACE">

  2010. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_BACKSPACE</span></span><a class="headerlink" href="#curses.KEY_BACKSPACE" title="Link to this definition">¶</a></dt>

  2011. <dd></dd></dl>

  2012. 

  2013. </td>

  2014. <td><p>Backspace (unreliable)</p></td>

  2015. </tr>

  2016. <tr class="row-even"><td><dl class="py data">

  2017. <dt class="sig sig-object py" id="curses.KEY_F0">

  2018. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_F0</span></span><a class="headerlink" href="#curses.KEY_F0" title="Link to this definition">¶</a></dt>

  2019. <dd></dd></dl>

  2020. 

  2021. </td>

  2022. <td><p>Function keys.  Up to 64 function keys are

  2023. supported.</p></td>

  2024. </tr>

  2025. <tr class="row-odd"><td><dl class="py data">

  2026. <dt class="sig sig-object py" id="curses.KEY_Fn">

  2027. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_Fn</span></span><a class="headerlink" href="#curses.KEY_Fn" title="Link to this definition">¶</a></dt>

  2028. <dd></dd></dl>

  2029. 

  2030. </td>

  2031. <td><p>Value of function key <em>n</em></p></td>

  2032. </tr>

  2033. <tr class="row-even"><td><dl class="py data">

  2034. <dt class="sig sig-object py" id="curses.KEY_DL">

  2035. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_DL</span></span><a class="headerlink" href="#curses.KEY_DL" title="Link to this definition">¶</a></dt>

  2036. <dd></dd></dl>

  2037. 

  2038. </td>

  2039. <td><p>Delete line</p></td>

  2040. </tr>

  2041. <tr class="row-odd"><td><dl class="py data">

  2042. <dt class="sig sig-object py" id="curses.KEY_IL">

  2043. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_IL</span></span><a class="headerlink" href="#curses.KEY_IL" title="Link to this definition">¶</a></dt>

  2044. <dd></dd></dl>

  2045. 

  2046. </td>

  2047. <td><p>Insert line</p></td>

  2048. </tr>

  2049. <tr class="row-even"><td><dl class="py data">

  2050. <dt class="sig sig-object py" id="curses.KEY_DC">

  2051. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_DC</span></span><a class="headerlink" href="#curses.KEY_DC" title="Link to this definition">¶</a></dt>

  2052. <dd></dd></dl>

  2053. 

  2054. </td>

  2055. <td><p>Delete character</p></td>

  2056. </tr>

  2057. <tr class="row-odd"><td><dl class="py data">

  2058. <dt class="sig sig-object py" id="curses.KEY_IC">

  2059. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_IC</span></span><a class="headerlink" href="#curses.KEY_IC" title="Link to this definition">¶</a></dt>

  2060. <dd></dd></dl>

  2061. 

  2062. </td>

  2063. <td><p>Insert char or enter insert mode</p></td>

  2064. </tr>

  2065. <tr class="row-even"><td><dl class="py data">

  2066. <dt class="sig sig-object py" id="curses.KEY_EIC">

  2067. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_EIC</span></span><a class="headerlink" href="#curses.KEY_EIC" title="Link to this definition">¶</a></dt>

  2068. <dd></dd></dl>

  2069. 

  2070. </td>

  2071. <td><p>Exit insert char mode</p></td>

  2072. </tr>

  2073. <tr class="row-odd"><td><dl class="py data">

  2074. <dt class="sig sig-object py" id="curses.KEY_CLEAR">

  2075. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_CLEAR</span></span><a class="headerlink" href="#curses.KEY_CLEAR" title="Link to this definition">¶</a></dt>

  2076. <dd></dd></dl>

  2077. 

  2078. </td>

  2079. <td><p>Clear screen</p></td>

  2080. </tr>

  2081. <tr class="row-even"><td><dl class="py data">

  2082. <dt class="sig sig-object py" id="curses.KEY_EOS">

  2083. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_EOS</span></span><a class="headerlink" href="#curses.KEY_EOS" title="Link to this definition">¶</a></dt>

  2084. <dd></dd></dl>

  2085. 

  2086. </td>

  2087. <td><p>Clear to end of screen</p></td>

  2088. </tr>

  2089. <tr class="row-odd"><td><dl class="py data">

  2090. <dt class="sig sig-object py" id="curses.KEY_EOL">

  2091. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_EOL</span></span><a class="headerlink" href="#curses.KEY_EOL" title="Link to this definition">¶</a></dt>

  2092. <dd></dd></dl>

  2093. 

  2094. </td>

  2095. <td><p>Clear to end of line</p></td>

  2096. </tr>

  2097. <tr class="row-even"><td><dl class="py data">

  2098. <dt class="sig sig-object py" id="curses.KEY_SF">

  2099. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SF</span></span><a class="headerlink" href="#curses.KEY_SF" title="Link to this definition">¶</a></dt>

  2100. <dd></dd></dl>

  2101. 

  2102. </td>

  2103. <td><p>Scroll 1 line forward</p></td>

  2104. </tr>

  2105. <tr class="row-odd"><td><dl class="py data">

  2106. <dt class="sig sig-object py" id="curses.KEY_SR">

  2107. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SR</span></span><a class="headerlink" href="#curses.KEY_SR" title="Link to this definition">¶</a></dt>

  2108. <dd></dd></dl>

  2109. 

  2110. </td>

  2111. <td><p>Scroll 1 line backward (reverse)</p></td>

  2112. </tr>

  2113. <tr class="row-even"><td><dl class="py data">

  2114. <dt class="sig sig-object py" id="curses.KEY_NPAGE">

  2115. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_NPAGE</span></span><a class="headerlink" href="#curses.KEY_NPAGE" title="Link to this definition">¶</a></dt>

  2116. <dd></dd></dl>

  2117. 

  2118. </td>

  2119. <td><p>Next page</p></td>

  2120. </tr>

  2121. <tr class="row-odd"><td><dl class="py data">

  2122. <dt class="sig sig-object py" id="curses.KEY_PPAGE">

  2123. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_PPAGE</span></span><a class="headerlink" href="#curses.KEY_PPAGE" title="Link to this definition">¶</a></dt>

  2124. <dd></dd></dl>

  2125. 

  2126. </td>

  2127. <td><p>Previous page</p></td>

  2128. </tr>

  2129. <tr class="row-even"><td><dl class="py data">

  2130. <dt class="sig sig-object py" id="curses.KEY_STAB">

  2131. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_STAB</span></span><a class="headerlink" href="#curses.KEY_STAB" title="Link to this definition">¶</a></dt>

  2132. <dd></dd></dl>

  2133. 

  2134. </td>

  2135. <td><p>Set tab</p></td>

  2136. </tr>

  2137. <tr class="row-odd"><td><dl class="py data">

  2138. <dt class="sig sig-object py" id="curses.KEY_CTAB">

  2139. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_CTAB</span></span><a class="headerlink" href="#curses.KEY_CTAB" title="Link to this definition">¶</a></dt>

  2140. <dd></dd></dl>

  2141. 

  2142. </td>

  2143. <td><p>Clear tab</p></td>

  2144. </tr>

  2145. <tr class="row-even"><td><dl class="py data">

  2146. <dt class="sig sig-object py" id="curses.KEY_CATAB">

  2147. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_CATAB</span></span><a class="headerlink" href="#curses.KEY_CATAB" title="Link to this definition">¶</a></dt>

  2148. <dd></dd></dl>

  2149. 

  2150. </td>

  2151. <td><p>Clear all tabs</p></td>

  2152. </tr>

  2153. <tr class="row-odd"><td><dl class="py data">

  2154. <dt class="sig sig-object py" id="curses.KEY_ENTER">

  2155. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_ENTER</span></span><a class="headerlink" href="#curses.KEY_ENTER" title="Link to this definition">¶</a></dt>

  2156. <dd></dd></dl>

  2157. 

  2158. </td>

  2159. <td><p>Enter or send (unreliable)</p></td>

  2160. </tr>

  2161. <tr class="row-even"><td><dl class="py data">

  2162. <dt class="sig sig-object py" id="curses.KEY_SRESET">

  2163. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SRESET</span></span><a class="headerlink" href="#curses.KEY_SRESET" title="Link to this definition">¶</a></dt>

  2164. <dd></dd></dl>

  2165. 

  2166. </td>

  2167. <td><p>Soft (partial) reset (unreliable)</p></td>

  2168. </tr>

  2169. <tr class="row-odd"><td><dl class="py data">

  2170. <dt class="sig sig-object py" id="curses.KEY_RESET">

  2171. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_RESET</span></span><a class="headerlink" href="#curses.KEY_RESET" title="Link to this definition">¶</a></dt>

  2172. <dd></dd></dl>

  2173. 

  2174. </td>

  2175. <td><p>Reset or hard reset (unreliable)</p></td>

  2176. </tr>

  2177. <tr class="row-even"><td><dl class="py data">

  2178. <dt class="sig sig-object py" id="curses.KEY_PRINT">

  2179. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_PRINT</span></span><a class="headerlink" href="#curses.KEY_PRINT" title="Link to this definition">¶</a></dt>

  2180. <dd></dd></dl>

  2181. 

  2182. </td>

  2183. <td><p>Print</p></td>

  2184. </tr>

  2185. <tr class="row-odd"><td><dl class="py data">

  2186. <dt class="sig sig-object py" id="curses.KEY_LL">

  2187. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_LL</span></span><a class="headerlink" href="#curses.KEY_LL" title="Link to this definition">¶</a></dt>

  2188. <dd></dd></dl>

  2189. 

  2190. </td>

  2191. <td><p>Home down or bottom (lower left)</p></td>

  2192. </tr>

  2193. <tr class="row-even"><td><dl class="py data">

  2194. <dt class="sig sig-object py" id="curses.KEY_A1">

  2195. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_A1</span></span><a class="headerlink" href="#curses.KEY_A1" title="Link to this definition">¶</a></dt>

  2196. <dd></dd></dl>

  2197. 

  2198. </td>

  2199. <td><p>Upper left of keypad</p></td>

  2200. </tr>

  2201. <tr class="row-odd"><td><dl class="py data">

  2202. <dt class="sig sig-object py" id="curses.KEY_A3">

  2203. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_A3</span></span><a class="headerlink" href="#curses.KEY_A3" title="Link to this definition">¶</a></dt>

  2204. <dd></dd></dl>

  2205. 

  2206. </td>

  2207. <td><p>Upper right of keypad</p></td>

  2208. </tr>

  2209. <tr class="row-even"><td><dl class="py data">

  2210. <dt class="sig sig-object py" id="curses.KEY_B2">

  2211. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_B2</span></span><a class="headerlink" href="#curses.KEY_B2" title="Link to this definition">¶</a></dt>

  2212. <dd></dd></dl>

  2213. 

  2214. </td>

  2215. <td><p>Center of keypad</p></td>

  2216. </tr>

  2217. <tr class="row-odd"><td><dl class="py data">

  2218. <dt class="sig sig-object py" id="curses.KEY_C1">

  2219. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_C1</span></span><a class="headerlink" href="#curses.KEY_C1" title="Link to this definition">¶</a></dt>

  2220. <dd></dd></dl>

  2221. 

  2222. </td>

  2223. <td><p>Lower left of keypad</p></td>

  2224. </tr>

  2225. <tr class="row-even"><td><dl class="py data">

  2226. <dt class="sig sig-object py" id="curses.KEY_C3">

  2227. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_C3</span></span><a class="headerlink" href="#curses.KEY_C3" title="Link to this definition">¶</a></dt>

  2228. <dd></dd></dl>

  2229. 

  2230. </td>

  2231. <td><p>Lower right of keypad</p></td>

  2232. </tr>

  2233. <tr class="row-odd"><td><dl class="py data">

  2234. <dt class="sig sig-object py" id="curses.KEY_BTAB">

  2235. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_BTAB</span></span><a class="headerlink" href="#curses.KEY_BTAB" title="Link to this definition">¶</a></dt>

  2236. <dd></dd></dl>

  2237. 

  2238. </td>

  2239. <td><p>Back tab</p></td>

  2240. </tr>

  2241. <tr class="row-even"><td><dl class="py data">

  2242. <dt class="sig sig-object py" id="curses.KEY_BEG">

  2243. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_BEG</span></span><a class="headerlink" href="#curses.KEY_BEG" title="Link to this definition">¶</a></dt>

  2244. <dd></dd></dl>

  2245. 

  2246. </td>

  2247. <td><p>Beg (beginning)</p></td>

  2248. </tr>

  2249. <tr class="row-odd"><td><dl class="py data">

  2250. <dt class="sig sig-object py" id="curses.KEY_CANCEL">

  2251. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_CANCEL</span></span><a class="headerlink" href="#curses.KEY_CANCEL" title="Link to this definition">¶</a></dt>

  2252. <dd></dd></dl>

  2253. 

  2254. </td>

  2255. <td><p>Cancel</p></td>

  2256. </tr>

  2257. <tr class="row-even"><td><dl class="py data">

  2258. <dt class="sig sig-object py" id="curses.KEY_CLOSE">

  2259. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_CLOSE</span></span><a class="headerlink" href="#curses.KEY_CLOSE" title="Link to this definition">¶</a></dt>

  2260. <dd></dd></dl>

  2261. 

  2262. </td>

  2263. <td><p>Close</p></td>

  2264. </tr>

  2265. <tr class="row-odd"><td><dl class="py data">

  2266. <dt class="sig sig-object py" id="curses.KEY_COMMAND">

  2267. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_COMMAND</span></span><a class="headerlink" href="#curses.KEY_COMMAND" title="Link to this definition">¶</a></dt>

  2268. <dd></dd></dl>

  2269. 

  2270. </td>

  2271. <td><p>Cmd (command)</p></td>

  2272. </tr>

  2273. <tr class="row-even"><td><dl class="py data">

  2274. <dt class="sig sig-object py" id="curses.KEY_COPY">

  2275. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_COPY</span></span><a class="headerlink" href="#curses.KEY_COPY" title="Link to this definition">¶</a></dt>

  2276. <dd></dd></dl>

  2277. 

  2278. </td>

  2279. <td><p>Copy</p></td>

  2280. </tr>

  2281. <tr class="row-odd"><td><dl class="py data">

  2282. <dt class="sig sig-object py" id="curses.KEY_CREATE">

  2283. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_CREATE</span></span><a class="headerlink" href="#curses.KEY_CREATE" title="Link to this definition">¶</a></dt>

  2284. <dd></dd></dl>

  2285. 

  2286. </td>

  2287. <td><p>Create</p></td>

  2288. </tr>

  2289. <tr class="row-even"><td><dl class="py data">

  2290. <dt class="sig sig-object py" id="curses.KEY_END">

  2291. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_END</span></span><a class="headerlink" href="#curses.KEY_END" title="Link to this definition">¶</a></dt>

  2292. <dd></dd></dl>

  2293. 

  2294. </td>

  2295. <td><p>End</p></td>

  2296. </tr>

  2297. <tr class="row-odd"><td><dl class="py data">

  2298. <dt class="sig sig-object py" id="curses.KEY_EXIT">

  2299. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_EXIT</span></span><a class="headerlink" href="#curses.KEY_EXIT" title="Link to this definition">¶</a></dt>

  2300. <dd></dd></dl>

  2301. 

  2302. </td>

  2303. <td><p>Exit</p></td>

  2304. </tr>

  2305. <tr class="row-even"><td><dl class="py data">

  2306. <dt class="sig sig-object py" id="curses.KEY_FIND">

  2307. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_FIND</span></span><a class="headerlink" href="#curses.KEY_FIND" title="Link to this definition">¶</a></dt>

  2308. <dd></dd></dl>

  2309. 

  2310. </td>

  2311. <td><p>Find</p></td>

  2312. </tr>

  2313. <tr class="row-odd"><td><dl class="py data">

  2314. <dt class="sig sig-object py" id="curses.KEY_HELP">

  2315. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_HELP</span></span><a class="headerlink" href="#curses.KEY_HELP" title="Link to this definition">¶</a></dt>

  2316. <dd></dd></dl>

  2317. 

  2318. </td>

  2319. <td><p>Help</p></td>

  2320. </tr>

  2321. <tr class="row-even"><td><dl class="py data">

  2322. <dt class="sig sig-object py" id="curses.KEY_MARK">

  2323. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_MARK</span></span><a class="headerlink" href="#curses.KEY_MARK" title="Link to this definition">¶</a></dt>

  2324. <dd></dd></dl>

  2325. 

  2326. </td>

  2327. <td><p>Mark</p></td>

  2328. </tr>

  2329. <tr class="row-odd"><td><dl class="py data">

  2330. <dt class="sig sig-object py" id="curses.KEY_MESSAGE">

  2331. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_MESSAGE</span></span><a class="headerlink" href="#curses.KEY_MESSAGE" title="Link to this definition">¶</a></dt>

  2332. <dd></dd></dl>

  2333. 

  2334. </td>

  2335. <td><p>Message</p></td>

  2336. </tr>

  2337. <tr class="row-even"><td><dl class="py data">

  2338. <dt class="sig sig-object py" id="curses.KEY_MOVE">

  2339. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_MOVE</span></span><a class="headerlink" href="#curses.KEY_MOVE" title="Link to this definition">¶</a></dt>

  2340. <dd></dd></dl>

  2341. 

  2342. </td>

  2343. <td><p>Move</p></td>

  2344. </tr>

  2345. <tr class="row-odd"><td><dl class="py data">

  2346. <dt class="sig sig-object py" id="curses.KEY_NEXT">

  2347. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_NEXT</span></span><a class="headerlink" href="#curses.KEY_NEXT" title="Link to this definition">¶</a></dt>

  2348. <dd></dd></dl>

  2349. 

  2350. </td>

  2351. <td><p>Next</p></td>

  2352. </tr>

  2353. <tr class="row-even"><td><dl class="py data">

  2354. <dt class="sig sig-object py" id="curses.KEY_OPEN">

  2355. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_OPEN</span></span><a class="headerlink" href="#curses.KEY_OPEN" title="Link to this definition">¶</a></dt>

  2356. <dd></dd></dl>

  2357. 

  2358. </td>

  2359. <td><p>Open</p></td>

  2360. </tr>

  2361. <tr class="row-odd"><td><dl class="py data">

  2362. <dt class="sig sig-object py" id="curses.KEY_OPTIONS">

  2363. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_OPTIONS</span></span><a class="headerlink" href="#curses.KEY_OPTIONS" title="Link to this definition">¶</a></dt>

  2364. <dd></dd></dl>

  2365. 

  2366. </td>

  2367. <td><p>Options</p></td>

  2368. </tr>

  2369. <tr class="row-even"><td><dl class="py data">

  2370. <dt class="sig sig-object py" id="curses.KEY_PREVIOUS">

  2371. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_PREVIOUS</span></span><a class="headerlink" href="#curses.KEY_PREVIOUS" title="Link to this definition">¶</a></dt>

  2372. <dd></dd></dl>

  2373. 

  2374. </td>

  2375. <td><p>Prev (previous)</p></td>

  2376. </tr>

  2377. <tr class="row-odd"><td><dl class="py data">

  2378. <dt class="sig sig-object py" id="curses.KEY_REDO">

  2379. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_REDO</span></span><a class="headerlink" href="#curses.KEY_REDO" title="Link to this definition">¶</a></dt>

  2380. <dd></dd></dl>

  2381. 

  2382. </td>

  2383. <td><p>Redo</p></td>

  2384. </tr>

  2385. <tr class="row-even"><td><dl class="py data">

  2386. <dt class="sig sig-object py" id="curses.KEY_REFERENCE">

  2387. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_REFERENCE</span></span><a class="headerlink" href="#curses.KEY_REFERENCE" title="Link to this definition">¶</a></dt>

  2388. <dd></dd></dl>

  2389. 

  2390. </td>

  2391. <td><p>Ref (reference)</p></td>

  2392. </tr>

  2393. <tr class="row-odd"><td><dl class="py data">

  2394. <dt class="sig sig-object py" id="curses.KEY_REFRESH">

  2395. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_REFRESH</span></span><a class="headerlink" href="#curses.KEY_REFRESH" title="Link to this definition">¶</a></dt>

  2396. <dd></dd></dl>

  2397. 

  2398. </td>

  2399. <td><p>Refresh</p></td>

  2400. </tr>

  2401. <tr class="row-even"><td><dl class="py data">

  2402. <dt class="sig sig-object py" id="curses.KEY_REPLACE">

  2403. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_REPLACE</span></span><a class="headerlink" href="#curses.KEY_REPLACE" title="Link to this definition">¶</a></dt>

  2404. <dd></dd></dl>

  2405. 

  2406. </td>

  2407. <td><p>Replace</p></td>

  2408. </tr>

  2409. <tr class="row-odd"><td><dl class="py data">

  2410. <dt class="sig sig-object py" id="curses.KEY_RESTART">

  2411. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_RESTART</span></span><a class="headerlink" href="#curses.KEY_RESTART" title="Link to this definition">¶</a></dt>

  2412. <dd></dd></dl>

  2413. 

  2414. </td>

  2415. <td><p>Restart</p></td>

  2416. </tr>

  2417. <tr class="row-even"><td><dl class="py data">

  2418. <dt class="sig sig-object py" id="curses.KEY_RESUME">

  2419. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_RESUME</span></span><a class="headerlink" href="#curses.KEY_RESUME" title="Link to this definition">¶</a></dt>

  2420. <dd></dd></dl>

  2421. 

  2422. </td>

  2423. <td><p>Resume</p></td>

  2424. </tr>

  2425. <tr class="row-odd"><td><dl class="py data">

  2426. <dt class="sig sig-object py" id="curses.KEY_SAVE">

  2427. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SAVE</span></span><a class="headerlink" href="#curses.KEY_SAVE" title="Link to this definition">¶</a></dt>

  2428. <dd></dd></dl>

  2429. 

  2430. </td>

  2431. <td><p>Save</p></td>

  2432. </tr>

  2433. <tr class="row-even"><td><dl class="py data">

  2434. <dt class="sig sig-object py" id="curses.KEY_SBEG">

  2435. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SBEG</span></span><a class="headerlink" href="#curses.KEY_SBEG" title="Link to this definition">¶</a></dt>

  2436. <dd></dd></dl>

  2437. 

  2438. </td>

  2439. <td><p>Shifted Beg (beginning)</p></td>

  2440. </tr>

  2441. <tr class="row-odd"><td><dl class="py data">

  2442. <dt class="sig sig-object py" id="curses.KEY_SCANCEL">

  2443. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SCANCEL</span></span><a class="headerlink" href="#curses.KEY_SCANCEL" title="Link to this definition">¶</a></dt>

  2444. <dd></dd></dl>

  2445. 

  2446. </td>

  2447. <td><p>Shifted Cancel</p></td>

  2448. </tr>

  2449. <tr class="row-even"><td><dl class="py data">

  2450. <dt class="sig sig-object py" id="curses.KEY_SCOMMAND">

  2451. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SCOMMAND</span></span><a class="headerlink" href="#curses.KEY_SCOMMAND" title="Link to this definition">¶</a></dt>

  2452. <dd></dd></dl>

  2453. 

  2454. </td>

  2455. <td><p>Shifted Command</p></td>

  2456. </tr>

  2457. <tr class="row-odd"><td><dl class="py data">

  2458. <dt class="sig sig-object py" id="curses.KEY_SCOPY">

  2459. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SCOPY</span></span><a class="headerlink" href="#curses.KEY_SCOPY" title="Link to this definition">¶</a></dt>

  2460. <dd></dd></dl>

  2461. 

  2462. </td>

  2463. <td><p>Shifted Copy</p></td>

  2464. </tr>

  2465. <tr class="row-even"><td><dl class="py data">

  2466. <dt class="sig sig-object py" id="curses.KEY_SCREATE">

  2467. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SCREATE</span></span><a class="headerlink" href="#curses.KEY_SCREATE" title="Link to this definition">¶</a></dt>

  2468. <dd></dd></dl>

  2469. 

  2470. </td>

  2471. <td><p>Shifted Create</p></td>

  2472. </tr>

  2473. <tr class="row-odd"><td><dl class="py data">

  2474. <dt class="sig sig-object py" id="curses.KEY_SDC">

  2475. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SDC</span></span><a class="headerlink" href="#curses.KEY_SDC" title="Link to this definition">¶</a></dt>

  2476. <dd></dd></dl>

  2477. 

  2478. </td>

  2479. <td><p>Shifted Delete char</p></td>

  2480. </tr>

  2481. <tr class="row-even"><td><dl class="py data">

  2482. <dt class="sig sig-object py" id="curses.KEY_SDL">

  2483. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SDL</span></span><a class="headerlink" href="#curses.KEY_SDL" title="Link to this definition">¶</a></dt>

  2484. <dd></dd></dl>

  2485. 

  2486. </td>

  2487. <td><p>Shifted Delete line</p></td>

  2488. </tr>

  2489. <tr class="row-odd"><td><dl class="py data">

  2490. <dt class="sig sig-object py" id="curses.KEY_SELECT">

  2491. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SELECT</span></span><a class="headerlink" href="#curses.KEY_SELECT" title="Link to this definition">¶</a></dt>

  2492. <dd></dd></dl>

  2493. 

  2494. </td>

  2495. <td><p>Select</p></td>

  2496. </tr>

  2497. <tr class="row-even"><td><dl class="py data">

  2498. <dt class="sig sig-object py" id="curses.KEY_SEND">

  2499. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SEND</span></span><a class="headerlink" href="#curses.KEY_SEND" title="Link to this definition">¶</a></dt>

  2500. <dd></dd></dl>

  2501. 

  2502. </td>

  2503. <td><p>Shifted End</p></td>

  2504. </tr>

  2505. <tr class="row-odd"><td><dl class="py data">

  2506. <dt class="sig sig-object py" id="curses.KEY_SEOL">

  2507. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SEOL</span></span><a class="headerlink" href="#curses.KEY_SEOL" title="Link to this definition">¶</a></dt>

  2508. <dd></dd></dl>

  2509. 

  2510. </td>

  2511. <td><p>Shifted Clear line</p></td>

  2512. </tr>

  2513. <tr class="row-even"><td><dl class="py data">

  2514. <dt class="sig sig-object py" id="curses.KEY_SEXIT">

  2515. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SEXIT</span></span><a class="headerlink" href="#curses.KEY_SEXIT" title="Link to this definition">¶</a></dt>

  2516. <dd></dd></dl>

  2517. 

  2518. </td>

  2519. <td><p>Shifted Exit</p></td>

  2520. </tr>

  2521. <tr class="row-odd"><td><dl class="py data">

  2522. <dt class="sig sig-object py" id="curses.KEY_SFIND">

  2523. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SFIND</span></span><a class="headerlink" href="#curses.KEY_SFIND" title="Link to this definition">¶</a></dt>

  2524. <dd></dd></dl>

  2525. 

  2526. </td>

  2527. <td><p>Shifted Find</p></td>

  2528. </tr>

  2529. <tr class="row-even"><td><dl class="py data">

  2530. <dt class="sig sig-object py" id="curses.KEY_SHELP">

  2531. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SHELP</span></span><a class="headerlink" href="#curses.KEY_SHELP" title="Link to this definition">¶</a></dt>

  2532. <dd></dd></dl>

  2533. 

  2534. </td>

  2535. <td><p>Shifted Help</p></td>

  2536. </tr>

  2537. <tr class="row-odd"><td><dl class="py data">

  2538. <dt class="sig sig-object py" id="curses.KEY_SHOME">

  2539. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SHOME</span></span><a class="headerlink" href="#curses.KEY_SHOME" title="Link to this definition">¶</a></dt>

  2540. <dd></dd></dl>

  2541. 

  2542. </td>

  2543. <td><p>Shifted Home</p></td>

  2544. </tr>

  2545. <tr class="row-even"><td><dl class="py data">

  2546. <dt class="sig sig-object py" id="curses.KEY_SIC">

  2547. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SIC</span></span><a class="headerlink" href="#curses.KEY_SIC" title="Link to this definition">¶</a></dt>

  2548. <dd></dd></dl>

  2549. 

  2550. </td>

  2551. <td><p>Shifted Input</p></td>

  2552. </tr>

  2553. <tr class="row-odd"><td><dl class="py data">

  2554. <dt class="sig sig-object py" id="curses.KEY_SLEFT">

  2555. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SLEFT</span></span><a class="headerlink" href="#curses.KEY_SLEFT" title="Link to this definition">¶</a></dt>

  2556. <dd></dd></dl>

  2557. 

  2558. </td>

  2559. <td><p>Shifted Left arrow</p></td>

  2560. </tr>

  2561. <tr class="row-even"><td><dl class="py data">

  2562. <dt class="sig sig-object py" id="curses.KEY_SMESSAGE">

  2563. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SMESSAGE</span></span><a class="headerlink" href="#curses.KEY_SMESSAGE" title="Link to this definition">¶</a></dt>

  2564. <dd></dd></dl>

  2565. 

  2566. </td>

  2567. <td><p>Shifted Message</p></td>

  2568. </tr>

  2569. <tr class="row-odd"><td><dl class="py data">

  2570. <dt class="sig sig-object py" id="curses.KEY_SMOVE">

  2571. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SMOVE</span></span><a class="headerlink" href="#curses.KEY_SMOVE" title="Link to this definition">¶</a></dt>

  2572. <dd></dd></dl>

  2573. 

  2574. </td>

  2575. <td><p>Shifted Move</p></td>

  2576. </tr>

  2577. <tr class="row-even"><td><dl class="py data">

  2578. <dt class="sig sig-object py" id="curses.KEY_SNEXT">

  2579. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SNEXT</span></span><a class="headerlink" href="#curses.KEY_SNEXT" title="Link to this definition">¶</a></dt>

  2580. <dd></dd></dl>

  2581. 

  2582. </td>

  2583. <td><p>Shifted Next</p></td>

  2584. </tr>

  2585. <tr class="row-odd"><td><dl class="py data">

  2586. <dt class="sig sig-object py" id="curses.KEY_SOPTIONS">

  2587. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SOPTIONS</span></span><a class="headerlink" href="#curses.KEY_SOPTIONS" title="Link to this definition">¶</a></dt>

  2588. <dd></dd></dl>

  2589. 

  2590. </td>

  2591. <td><p>Shifted Options</p></td>

  2592. </tr>

  2593. <tr class="row-even"><td><dl class="py data">

  2594. <dt class="sig sig-object py" id="curses.KEY_SPREVIOUS">

  2595. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SPREVIOUS</span></span><a class="headerlink" href="#curses.KEY_SPREVIOUS" title="Link to this definition">¶</a></dt>

  2596. <dd></dd></dl>

  2597. 

  2598. </td>

  2599. <td><p>Shifted Prev</p></td>

  2600. </tr>

  2601. <tr class="row-odd"><td><dl class="py data">

  2602. <dt class="sig sig-object py" id="curses.KEY_SPRINT">

  2603. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SPRINT</span></span><a class="headerlink" href="#curses.KEY_SPRINT" title="Link to this definition">¶</a></dt>

  2604. <dd></dd></dl>

  2605. 

  2606. </td>

  2607. <td><p>Shifted Print</p></td>

  2608. </tr>

  2609. <tr class="row-even"><td><dl class="py data">

  2610. <dt class="sig sig-object py" id="curses.KEY_SREDO">

  2611. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SREDO</span></span><a class="headerlink" href="#curses.KEY_SREDO" title="Link to this definition">¶</a></dt>

  2612. <dd></dd></dl>

  2613. 

  2614. </td>

  2615. <td><p>Shifted Redo</p></td>

  2616. </tr>

  2617. <tr class="row-odd"><td><dl class="py data">

  2618. <dt class="sig sig-object py" id="curses.KEY_SREPLACE">

  2619. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SREPLACE</span></span><a class="headerlink" href="#curses.KEY_SREPLACE" title="Link to this definition">¶</a></dt>

  2620. <dd></dd></dl>

  2621. 

  2622. </td>

  2623. <td><p>Shifted Replace</p></td>

  2624. </tr>

  2625. <tr class="row-even"><td><dl class="py data">

  2626. <dt class="sig sig-object py" id="curses.KEY_SRIGHT">

  2627. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SRIGHT</span></span><a class="headerlink" href="#curses.KEY_SRIGHT" title="Link to this definition">¶</a></dt>

  2628. <dd></dd></dl>

  2629. 

  2630. </td>

  2631. <td><p>Shifted Right arrow</p></td>

  2632. </tr>

  2633. <tr class="row-odd"><td><dl class="py data">

  2634. <dt class="sig sig-object py" id="curses.KEY_SRSUME">

  2635. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SRSUME</span></span><a class="headerlink" href="#curses.KEY_SRSUME" title="Link to this definition">¶</a></dt>

  2636. <dd></dd></dl>

  2637. 

  2638. </td>

  2639. <td><p>Shifted Resume</p></td>

  2640. </tr>

  2641. <tr class="row-even"><td><dl class="py data">

  2642. <dt class="sig sig-object py" id="curses.KEY_SSAVE">

  2643. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SSAVE</span></span><a class="headerlink" href="#curses.KEY_SSAVE" title="Link to this definition">¶</a></dt>

  2644. <dd></dd></dl>

  2645. 

  2646. </td>

  2647. <td><p>Shifted Save</p></td>

  2648. </tr>

  2649. <tr class="row-odd"><td><dl class="py data">

  2650. <dt class="sig sig-object py" id="curses.KEY_SSUSPEND">

  2651. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SSUSPEND</span></span><a class="headerlink" href="#curses.KEY_SSUSPEND" title="Link to this definition">¶</a></dt>

  2652. <dd></dd></dl>

  2653. 

  2654. </td>

  2655. <td><p>Shifted Suspend</p></td>

  2656. </tr>

  2657. <tr class="row-even"><td><dl class="py data">

  2658. <dt class="sig sig-object py" id="curses.KEY_SUNDO">

  2659. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SUNDO</span></span><a class="headerlink" href="#curses.KEY_SUNDO" title="Link to this definition">¶</a></dt>

  2660. <dd></dd></dl>

  2661. 

  2662. </td>

  2663. <td><p>Shifted Undo</p></td>

  2664. </tr>

  2665. <tr class="row-odd"><td><dl class="py data">

  2666. <dt class="sig sig-object py" id="curses.KEY_SUSPEND">

  2667. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_SUSPEND</span></span><a class="headerlink" href="#curses.KEY_SUSPEND" title="Link to this definition">¶</a></dt>

  2668. <dd></dd></dl>

  2669. 

  2670. </td>

  2671. <td><p>Suspend</p></td>

  2672. </tr>

  2673. <tr class="row-even"><td><dl class="py data">

  2674. <dt class="sig sig-object py" id="curses.KEY_UNDO">

  2675. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_UNDO</span></span><a class="headerlink" href="#curses.KEY_UNDO" title="Link to this definition">¶</a></dt>

  2676. <dd></dd></dl>

  2677. 

  2678. </td>

  2679. <td><p>Undo</p></td>

  2680. </tr>

  2681. <tr class="row-odd"><td><dl class="py data">

  2682. <dt class="sig sig-object py" id="curses.KEY_MOUSE">

  2683. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_MOUSE</span></span><a class="headerlink" href="#curses.KEY_MOUSE" title="Link to this definition">¶</a></dt>

  2684. <dd></dd></dl>

  2685. 

  2686. </td>

  2687. <td><p>Mouse event has occurred</p></td>

  2688. </tr>

  2689. <tr class="row-even"><td><dl class="py data">

  2690. <dt class="sig sig-object py" id="curses.KEY_RESIZE">

  2691. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_RESIZE</span></span><a class="headerlink" href="#curses.KEY_RESIZE" title="Link to this definition">¶</a></dt>

  2692. <dd></dd></dl>

  2693. 

  2694. </td>

  2695. <td><p>Terminal resize event</p></td>

  2696. </tr>

  2697. <tr class="row-odd"><td><dl class="py data">

  2698. <dt class="sig sig-object py" id="curses.KEY_MAX">

  2699. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">KEY_MAX</span></span><a class="headerlink" href="#curses.KEY_MAX" title="Link to this definition">¶</a></dt>

  2700. <dd></dd></dl>

  2701. 

  2702. </td>

  2703. <td><p>Maximum key value</p></td>

  2704. </tr>

  2705. </tbody>

  2706. </table>

  2707. <p>On VT100s and their software emulations, such as X terminal emulators, there are

  2708. normally at least four function keys (<a class="reference internal" href="#curses.KEY_Fn" title="curses.KEY_Fn"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_F1</span></code></a>, <a class="reference internal" href="#curses.KEY_Fn" title="curses.KEY_Fn"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_F2</span></code></a>,

  2709. <a class="reference internal" href="#curses.KEY_Fn" title="curses.KEY_Fn"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_F3</span></code></a>, <a class="reference internal" href="#curses.KEY_Fn" title="curses.KEY_Fn"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_F4</span></code></a>) available, and the arrow keys mapped to

  2710. <a class="reference internal" href="#curses.KEY_UP" title="curses.KEY_UP"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_UP</span></code></a>, <a class="reference internal" href="#curses.KEY_DOWN" title="curses.KEY_DOWN"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_DOWN</span></code></a>, <a class="reference internal" href="#curses.KEY_LEFT" title="curses.KEY_LEFT"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_LEFT</span></code></a> and <a class="reference internal" href="#curses.KEY_RIGHT" title="curses.KEY_RIGHT"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_RIGHT</span></code></a> in

  2711. the obvious way.  If your machine has a PC keyboard, it is safe to expect arrow

  2712. keys and twelve function keys (older PC keyboards may have only ten function

  2713. keys); also, the following keypad mappings are standard:</p>

  2714. <table class="docutils align-default">

  2715. <thead>

  2716. <tr class="row-odd"><th class="head"><p>Keycap</p></th>

  2717. <th class="head"><p>Constant</p></th>

  2718. </tr>

  2719. </thead>

  2720. <tbody>

  2721. <tr class="row-even"><td><p><kbd class="kbd docutils literal notranslate">Insert</kbd></p></td>

  2722. <td><p>KEY_IC</p></td>

  2723. </tr>

  2724. <tr class="row-odd"><td><p><kbd class="kbd docutils literal notranslate">Delete</kbd></p></td>

  2725. <td><p>KEY_DC</p></td>

  2726. </tr>

  2727. <tr class="row-even"><td><p><kbd class="kbd docutils literal notranslate">Home</kbd></p></td>

  2728. <td><p>KEY_HOME</p></td>

  2729. </tr>

  2730. <tr class="row-odd"><td><p><kbd class="kbd docutils literal notranslate">End</kbd></p></td>

  2731. <td><p>KEY_END</p></td>

  2732. </tr>

  2733. <tr class="row-even"><td><p><kbd class="kbd docutils literal notranslate">Page Up</kbd></p></td>

  2734. <td><p>KEY_PPAGE</p></td>

  2735. </tr>

  2736. <tr class="row-odd"><td><p><kbd class="kbd docutils literal notranslate">Page Down</kbd></p></td>

  2737. <td><p>KEY_NPAGE</p></td>

  2738. </tr>

  2739. </tbody>

  2740. </table>

  2741. <p id="curses-acs-codes">The following table lists characters from the alternate character set. These are

  2742. inherited from the VT100 terminal, and will generally be  available on software

  2743. emulations such as X terminals.  When there is no graphic available, curses

  2744. falls back on a crude printable ASCII approximation.</p>

  2745. <div class="admonition note">

  2746. <p class="admonition-title">Note</p>

  2747. <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>

  2748. </div>

  2749. <table class="docutils align-default">

  2750. <thead>

  2751. <tr class="row-odd"><th class="head"><p>ACS code</p></th>

  2752. <th class="head"><p>Meaning</p></th>

  2753. </tr>

  2754. </thead>

  2755. <tbody>

  2756. <tr class="row-even"><td><dl class="py data">

  2757. <dt class="sig sig-object py" id="curses.ACS_BBSS">

  2758. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_BBSS</span></span><a class="headerlink" href="#curses.ACS_BBSS" title="Link to this definition">¶</a></dt>

  2759. <dd></dd></dl>

  2760. 

  2761. </td>

  2762. <td><p>alternate name for upper right corner</p></td>

  2763. </tr>

  2764. <tr class="row-odd"><td><dl class="py data">

  2765. <dt class="sig sig-object py" id="curses.ACS_BLOCK">

  2766. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_BLOCK</span></span><a class="headerlink" href="#curses.ACS_BLOCK" title="Link to this definition">¶</a></dt>

  2767. <dd></dd></dl>

  2768. 

  2769. </td>

  2770. <td><p>solid square block</p></td>

  2771. </tr>

  2772. <tr class="row-even"><td><dl class="py data">

  2773. <dt class="sig sig-object py" id="curses.ACS_BOARD">

  2774. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_BOARD</span></span><a class="headerlink" href="#curses.ACS_BOARD" title="Link to this definition">¶</a></dt>

  2775. <dd></dd></dl>

  2776. 

  2777. </td>

  2778. <td><p>board of squares</p></td>

  2779. </tr>

  2780. <tr class="row-odd"><td><dl class="py data">

  2781. <dt class="sig sig-object py" id="curses.ACS_BSBS">

  2782. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_BSBS</span></span><a class="headerlink" href="#curses.ACS_BSBS" title="Link to this definition">¶</a></dt>

  2783. <dd></dd></dl>

  2784. 

  2785. </td>

  2786. <td><p>alternate name for horizontal line</p></td>

  2787. </tr>

  2788. <tr class="row-even"><td><dl class="py data">

  2789. <dt class="sig sig-object py" id="curses.ACS_BSSB">

  2790. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_BSSB</span></span><a class="headerlink" href="#curses.ACS_BSSB" title="Link to this definition">¶</a></dt>

  2791. <dd></dd></dl>

  2792. 

  2793. </td>

  2794. <td><p>alternate name for upper left corner</p></td>

  2795. </tr>

  2796. <tr class="row-odd"><td><dl class="py data">

  2797. <dt class="sig sig-object py" id="curses.ACS_BSSS">

  2798. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_BSSS</span></span><a class="headerlink" href="#curses.ACS_BSSS" title="Link to this definition">¶</a></dt>

  2799. <dd></dd></dl>

  2800. 

  2801. </td>

  2802. <td><p>alternate name for top tee</p></td>

  2803. </tr>

  2804. <tr class="row-even"><td><dl class="py data">

  2805. <dt class="sig sig-object py" id="curses.ACS_BTEE">

  2806. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_BTEE</span></span><a class="headerlink" href="#curses.ACS_BTEE" title="Link to this definition">¶</a></dt>

  2807. <dd></dd></dl>

  2808. 

  2809. </td>

  2810. <td><p>bottom tee</p></td>

  2811. </tr>

  2812. <tr class="row-odd"><td><dl class="py data">

  2813. <dt class="sig sig-object py" id="curses.ACS_BULLET">

  2814. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_BULLET</span></span><a class="headerlink" href="#curses.ACS_BULLET" title="Link to this definition">¶</a></dt>

  2815. <dd></dd></dl>

  2816. 

  2817. </td>

  2818. <td><p>bullet</p></td>

  2819. </tr>

  2820. <tr class="row-even"><td><dl class="py data">

  2821. <dt class="sig sig-object py" id="curses.ACS_CKBOARD">

  2822. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_CKBOARD</span></span><a class="headerlink" href="#curses.ACS_CKBOARD" title="Link to this definition">¶</a></dt>

  2823. <dd></dd></dl>

  2824. 

  2825. </td>

  2826. <td><p>checker board (stipple)</p></td>

  2827. </tr>

  2828. <tr class="row-odd"><td><dl class="py data">

  2829. <dt class="sig sig-object py" id="curses.ACS_DARROW">

  2830. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_DARROW</span></span><a class="headerlink" href="#curses.ACS_DARROW" title="Link to this definition">¶</a></dt>

  2831. <dd></dd></dl>

  2832. 

  2833. </td>

  2834. <td><p>arrow pointing down</p></td>

  2835. </tr>

  2836. <tr class="row-even"><td><dl class="py data">

  2837. <dt class="sig sig-object py" id="curses.ACS_DEGREE">

  2838. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_DEGREE</span></span><a class="headerlink" href="#curses.ACS_DEGREE" title="Link to this definition">¶</a></dt>

  2839. <dd></dd></dl>

  2840. 

  2841. </td>

  2842. <td><p>degree symbol</p></td>

  2843. </tr>

  2844. <tr class="row-odd"><td><dl class="py data">

  2845. <dt class="sig sig-object py" id="curses.ACS_DIAMOND">

  2846. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_DIAMOND</span></span><a class="headerlink" href="#curses.ACS_DIAMOND" title="Link to this definition">¶</a></dt>

  2847. <dd></dd></dl>

  2848. 

  2849. </td>

  2850. <td><p>diamond</p></td>

  2851. </tr>

  2852. <tr class="row-even"><td><dl class="py data">

  2853. <dt class="sig sig-object py" id="curses.ACS_GEQUAL">

  2854. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_GEQUAL</span></span><a class="headerlink" href="#curses.ACS_GEQUAL" title="Link to this definition">¶</a></dt>

  2855. <dd></dd></dl>

  2856. 

  2857. </td>

  2858. <td><p>greater-than-or-equal-to</p></td>

  2859. </tr>

  2860. <tr class="row-odd"><td><dl class="py data">

  2861. <dt class="sig sig-object py" id="curses.ACS_HLINE">

  2862. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_HLINE</span></span><a class="headerlink" href="#curses.ACS_HLINE" title="Link to this definition">¶</a></dt>

  2863. <dd></dd></dl>

  2864. 

  2865. </td>

  2866. <td><p>horizontal line</p></td>

  2867. </tr>

  2868. <tr class="row-even"><td><dl class="py data">

  2869. <dt class="sig sig-object py" id="curses.ACS_LANTERN">

  2870. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_LANTERN</span></span><a class="headerlink" href="#curses.ACS_LANTERN" title="Link to this definition">¶</a></dt>

  2871. <dd></dd></dl>

  2872. 

  2873. </td>

  2874. <td><p>lantern symbol</p></td>

  2875. </tr>

  2876. <tr class="row-odd"><td><dl class="py data">

  2877. <dt class="sig sig-object py" id="curses.ACS_LARROW">

  2878. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_LARROW</span></span><a class="headerlink" href="#curses.ACS_LARROW" title="Link to this definition">¶</a></dt>

  2879. <dd></dd></dl>

  2880. 

  2881. </td>

  2882. <td><p>left arrow</p></td>

  2883. </tr>

  2884. <tr class="row-even"><td><dl class="py data">

  2885. <dt class="sig sig-object py" id="curses.ACS_LEQUAL">

  2886. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_LEQUAL</span></span><a class="headerlink" href="#curses.ACS_LEQUAL" title="Link to this definition">¶</a></dt>

  2887. <dd></dd></dl>

  2888. 

  2889. </td>

  2890. <td><p>less-than-or-equal-to</p></td>

  2891. </tr>

  2892. <tr class="row-odd"><td><dl class="py data">

  2893. <dt class="sig sig-object py" id="curses.ACS_LLCORNER">

  2894. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_LLCORNER</span></span><a class="headerlink" href="#curses.ACS_LLCORNER" title="Link to this definition">¶</a></dt>

  2895. <dd></dd></dl>

  2896. 

  2897. </td>

  2898. <td><p>lower left-hand corner</p></td>

  2899. </tr>

  2900. <tr class="row-even"><td><dl class="py data">

  2901. <dt class="sig sig-object py" id="curses.ACS_LRCORNER">

  2902. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_LRCORNER</span></span><a class="headerlink" href="#curses.ACS_LRCORNER" title="Link to this definition">¶</a></dt>

  2903. <dd></dd></dl>

  2904. 

  2905. </td>

  2906. <td><p>lower right-hand corner</p></td>

  2907. </tr>

  2908. <tr class="row-odd"><td><dl class="py data">

  2909. <dt class="sig sig-object py" id="curses.ACS_LTEE">

  2910. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_LTEE</span></span><a class="headerlink" href="#curses.ACS_LTEE" title="Link to this definition">¶</a></dt>

  2911. <dd></dd></dl>

  2912. 

  2913. </td>

  2914. <td><p>left tee</p></td>

  2915. </tr>

  2916. <tr class="row-even"><td><dl class="py data">

  2917. <dt class="sig sig-object py" id="curses.ACS_NEQUAL">

  2918. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_NEQUAL</span></span><a class="headerlink" href="#curses.ACS_NEQUAL" title="Link to this definition">¶</a></dt>

  2919. <dd></dd></dl>

  2920. 

  2921. </td>

  2922. <td><p>not-equal sign</p></td>

  2923. </tr>

  2924. <tr class="row-odd"><td><dl class="py data">

  2925. <dt class="sig sig-object py" id="curses.ACS_PI">

  2926. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_PI</span></span><a class="headerlink" href="#curses.ACS_PI" title="Link to this definition">¶</a></dt>

  2927. <dd></dd></dl>

  2928. 

  2929. </td>

  2930. <td><p>letter pi</p></td>

  2931. </tr>

  2932. <tr class="row-even"><td><dl class="py data">

  2933. <dt class="sig sig-object py" id="curses.ACS_PLMINUS">

  2934. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_PLMINUS</span></span><a class="headerlink" href="#curses.ACS_PLMINUS" title="Link to this definition">¶</a></dt>

  2935. <dd></dd></dl>

  2936. 

  2937. </td>

  2938. <td><p>plus-or-minus sign</p></td>

  2939. </tr>

  2940. <tr class="row-odd"><td><dl class="py data">

  2941. <dt class="sig sig-object py" id="curses.ACS_PLUS">

  2942. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_PLUS</span></span><a class="headerlink" href="#curses.ACS_PLUS" title="Link to this definition">¶</a></dt>

  2943. <dd></dd></dl>

  2944. 

  2945. </td>

  2946. <td><p>big plus sign</p></td>

  2947. </tr>

  2948. <tr class="row-even"><td><dl class="py data">

  2949. <dt class="sig sig-object py" id="curses.ACS_RARROW">

  2950. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_RARROW</span></span><a class="headerlink" href="#curses.ACS_RARROW" title="Link to this definition">¶</a></dt>

  2951. <dd></dd></dl>

  2952. 

  2953. </td>

  2954. <td><p>right arrow</p></td>

  2955. </tr>

  2956. <tr class="row-odd"><td><dl class="py data">

  2957. <dt class="sig sig-object py" id="curses.ACS_RTEE">

  2958. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_RTEE</span></span><a class="headerlink" href="#curses.ACS_RTEE" title="Link to this definition">¶</a></dt>

  2959. <dd></dd></dl>

  2960. 

  2961. </td>

  2962. <td><p>right tee</p></td>

  2963. </tr>

  2964. <tr class="row-even"><td><dl class="py data">

  2965. <dt class="sig sig-object py" id="curses.ACS_S1">

  2966. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_S1</span></span><a class="headerlink" href="#curses.ACS_S1" title="Link to this definition">¶</a></dt>

  2967. <dd></dd></dl>

  2968. 

  2969. </td>

  2970. <td><p>scan line 1</p></td>

  2971. </tr>

  2972. <tr class="row-odd"><td><dl class="py data">

  2973. <dt class="sig sig-object py" id="curses.ACS_S3">

  2974. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_S3</span></span><a class="headerlink" href="#curses.ACS_S3" title="Link to this definition">¶</a></dt>

  2975. <dd></dd></dl>

  2976. 

  2977. </td>

  2978. <td><p>scan line 3</p></td>

  2979. </tr>

  2980. <tr class="row-even"><td><dl class="py data">

  2981. <dt class="sig sig-object py" id="curses.ACS_S7">

  2982. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_S7</span></span><a class="headerlink" href="#curses.ACS_S7" title="Link to this definition">¶</a></dt>

  2983. <dd></dd></dl>

  2984. 

  2985. </td>

  2986. <td><p>scan line 7</p></td>

  2987. </tr>

  2988. <tr class="row-odd"><td><dl class="py data">

  2989. <dt class="sig sig-object py" id="curses.ACS_S9">

  2990. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_S9</span></span><a class="headerlink" href="#curses.ACS_S9" title="Link to this definition">¶</a></dt>

  2991. <dd></dd></dl>

  2992. 

  2993. </td>

  2994. <td><p>scan line 9</p></td>

  2995. </tr>

  2996. <tr class="row-even"><td><dl class="py data">

  2997. <dt class="sig sig-object py" id="curses.ACS_SBBS">

  2998. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_SBBS</span></span><a class="headerlink" href="#curses.ACS_SBBS" title="Link to this definition">¶</a></dt>

  2999. <dd></dd></dl>

  3000. 

  3001. </td>

  3002. <td><p>alternate name for lower right corner</p></td>

  3003. </tr>

  3004. <tr class="row-odd"><td><dl class="py data">

  3005. <dt class="sig sig-object py" id="curses.ACS_SBSB">

  3006. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_SBSB</span></span><a class="headerlink" href="#curses.ACS_SBSB" title="Link to this definition">¶</a></dt>

  3007. <dd></dd></dl>

  3008. 

  3009. </td>

  3010. <td><p>alternate name for vertical line</p></td>

  3011. </tr>

  3012. <tr class="row-even"><td><dl class="py data">

  3013. <dt class="sig sig-object py" id="curses.ACS_SBSS">

  3014. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_SBSS</span></span><a class="headerlink" href="#curses.ACS_SBSS" title="Link to this definition">¶</a></dt>

  3015. <dd></dd></dl>

  3016. 

  3017. </td>

  3018. <td><p>alternate name for right tee</p></td>

  3019. </tr>

  3020. <tr class="row-odd"><td><dl class="py data">

  3021. <dt class="sig sig-object py" id="curses.ACS_SSBB">

  3022. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_SSBB</span></span><a class="headerlink" href="#curses.ACS_SSBB" title="Link to this definition">¶</a></dt>

  3023. <dd></dd></dl>

  3024. 

  3025. </td>

  3026. <td><p>alternate name for lower left corner</p></td>

  3027. </tr>

  3028. <tr class="row-even"><td><dl class="py data">

  3029. <dt class="sig sig-object py" id="curses.ACS_SSBS">

  3030. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_SSBS</span></span><a class="headerlink" href="#curses.ACS_SSBS" title="Link to this definition">¶</a></dt>

  3031. <dd></dd></dl>

  3032. 

  3033. </td>

  3034. <td><p>alternate name for bottom tee</p></td>

  3035. </tr>

  3036. <tr class="row-odd"><td><dl class="py data">

  3037. <dt class="sig sig-object py" id="curses.ACS_SSSB">

  3038. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_SSSB</span></span><a class="headerlink" href="#curses.ACS_SSSB" title="Link to this definition">¶</a></dt>

  3039. <dd></dd></dl>

  3040. 

  3041. </td>

  3042. <td><p>alternate name for left tee</p></td>

  3043. </tr>

  3044. <tr class="row-even"><td><dl class="py data">

  3045. <dt class="sig sig-object py" id="curses.ACS_SSSS">

  3046. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_SSSS</span></span><a class="headerlink" href="#curses.ACS_SSSS" title="Link to this definition">¶</a></dt>

  3047. <dd></dd></dl>

  3048. 

  3049. </td>

  3050. <td><p>alternate name for crossover or big plus</p></td>

  3051. </tr>

  3052. <tr class="row-odd"><td><dl class="py data">

  3053. <dt class="sig sig-object py" id="curses.ACS_STERLING">

  3054. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_STERLING</span></span><a class="headerlink" href="#curses.ACS_STERLING" title="Link to this definition">¶</a></dt>

  3055. <dd></dd></dl>

  3056. 

  3057. </td>

  3058. <td><p>pound sterling</p></td>

  3059. </tr>

  3060. <tr class="row-even"><td><dl class="py data">

  3061. <dt class="sig sig-object py" id="curses.ACS_TTEE">

  3062. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_TTEE</span></span><a class="headerlink" href="#curses.ACS_TTEE" title="Link to this definition">¶</a></dt>

  3063. <dd></dd></dl>

  3064. 

  3065. </td>

  3066. <td><p>top tee</p></td>

  3067. </tr>

  3068. <tr class="row-odd"><td><dl class="py data">

  3069. <dt class="sig sig-object py" id="curses.ACS_UARROW">

  3070. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_UARROW</span></span><a class="headerlink" href="#curses.ACS_UARROW" title="Link to this definition">¶</a></dt>

  3071. <dd></dd></dl>

  3072. 

  3073. </td>

  3074. <td><p>up arrow</p></td>

  3075. </tr>

  3076. <tr class="row-even"><td><dl class="py data">

  3077. <dt class="sig sig-object py" id="curses.ACS_ULCORNER">

  3078. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_ULCORNER</span></span><a class="headerlink" href="#curses.ACS_ULCORNER" title="Link to this definition">¶</a></dt>

  3079. <dd></dd></dl>

  3080. 

  3081. </td>

  3082. <td><p>upper left corner</p></td>

  3083. </tr>

  3084. <tr class="row-odd"><td><dl class="py data">

  3085. <dt class="sig sig-object py" id="curses.ACS_URCORNER">

  3086. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_URCORNER</span></span><a class="headerlink" href="#curses.ACS_URCORNER" title="Link to this definition">¶</a></dt>

  3087. <dd></dd></dl>

  3088. 

  3089. </td>

  3090. <td><p>upper right corner</p></td>

  3091. </tr>

  3092. <tr class="row-even"><td><dl class="py data">

  3093. <dt class="sig sig-object py" id="curses.ACS_VLINE">

  3094. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">ACS_VLINE</span></span><a class="headerlink" href="#curses.ACS_VLINE" title="Link to this definition">¶</a></dt>

  3095. <dd></dd></dl>

  3096. 

  3097. </td>

  3098. <td><p>vertical line</p></td>

  3099. </tr>

  3100. </tbody>

  3101. </table>

  3102. <p>The following table lists mouse button constants used by <a class="reference internal" href="#curses.getmouse" title="curses.getmouse"><code class="xref py py-meth docutils literal notranslate"><span class="pre">getmouse()</span></code></a>:</p>

  3103. <table class="docutils align-default">

  3104. <thead>

  3105. <tr class="row-odd"><th class="head"><p>Mouse button constant</p></th>

  3106. <th class="head"><p>Meaning</p></th>

  3107. </tr>

  3108. </thead>

  3109. <tbody>

  3110. <tr class="row-even"><td><dl class="py data">

  3111. <dt class="sig sig-object py" id="curses.BUTTONn_PRESSED">

  3112. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">BUTTONn_PRESSED</span></span><a class="headerlink" href="#curses.BUTTONn_PRESSED" title="Link to this definition">¶</a></dt>

  3113. <dd></dd></dl>

  3114. 

  3115. </td>

  3116. <td><p>Mouse button <em>n</em> pressed</p></td>

  3117. </tr>

  3118. <tr class="row-odd"><td><dl class="py data">

  3119. <dt class="sig sig-object py" id="curses.BUTTONn_RELEASED">

  3120. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">BUTTONn_RELEASED</span></span><a class="headerlink" href="#curses.BUTTONn_RELEASED" title="Link to this definition">¶</a></dt>

  3121. <dd></dd></dl>

  3122. 

  3123. </td>

  3124. <td><p>Mouse button <em>n</em> released</p></td>

  3125. </tr>

  3126. <tr class="row-even"><td><dl class="py data">

  3127. <dt class="sig sig-object py" id="curses.BUTTONn_CLICKED">

  3128. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">BUTTONn_CLICKED</span></span><a class="headerlink" href="#curses.BUTTONn_CLICKED" title="Link to this definition">¶</a></dt>

  3129. <dd></dd></dl>

  3130. 

  3131. </td>

  3132. <td><p>Mouse button <em>n</em> clicked</p></td>

  3133. </tr>

  3134. <tr class="row-odd"><td><dl class="py data">

  3135. <dt class="sig sig-object py" id="curses.BUTTONn_DOUBLE_CLICKED">

  3136. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">BUTTONn_DOUBLE_CLICKED</span></span><a class="headerlink" href="#curses.BUTTONn_DOUBLE_CLICKED" title="Link to this definition">¶</a></dt>

  3137. <dd></dd></dl>

  3138. 

  3139. </td>

  3140. <td><p>Mouse button <em>n</em> double clicked</p></td>

  3141. </tr>

  3142. <tr class="row-even"><td><dl class="py data">

  3143. <dt class="sig sig-object py" id="curses.BUTTONn_TRIPLE_CLICKED">

  3144. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">BUTTONn_TRIPLE_CLICKED</span></span><a class="headerlink" href="#curses.BUTTONn_TRIPLE_CLICKED" title="Link to this definition">¶</a></dt>

  3145. <dd></dd></dl>

  3146. 

  3147. </td>

  3148. <td><p>Mouse button <em>n</em> triple clicked</p></td>

  3149. </tr>

  3150. <tr class="row-odd"><td><dl class="py data">

  3151. <dt class="sig sig-object py" id="curses.BUTTON_SHIFT">

  3152. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">BUTTON_SHIFT</span></span><a class="headerlink" href="#curses.BUTTON_SHIFT" title="Link to this definition">¶</a></dt>

  3153. <dd></dd></dl>

  3154. 

  3155. </td>

  3156. <td><p>Shift was down during button state change</p></td>

  3157. </tr>

  3158. <tr class="row-even"><td><dl class="py data">

  3159. <dt class="sig sig-object py" id="curses.BUTTON_CTRL">

  3160. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">BUTTON_CTRL</span></span><a class="headerlink" href="#curses.BUTTON_CTRL" title="Link to this definition">¶</a></dt>

  3161. <dd></dd></dl>

  3162. 

  3163. </td>

  3164. <td><p>Control was down during button state change</p></td>

  3165. </tr>

  3166. <tr class="row-odd"><td><dl class="py data">

  3167. <dt class="sig sig-object py" id="curses.BUTTON_ALT">

  3168. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">BUTTON_ALT</span></span><a class="headerlink" href="#curses.BUTTON_ALT" title="Link to this definition">¶</a></dt>

  3169. <dd></dd></dl>

  3170. 

  3171. </td>

  3172. <td><p>Control was down during button state change</p></td>

  3173. </tr>

  3174. </tbody>

  3175. </table>

  3176. <div class="versionchanged">

  3177. <p><span class="versionmodified changed">Changed in version 3.10: </span>The <code class="docutils literal notranslate"><span class="pre">BUTTON5_*</span></code> constants are now exposed if they are provided by the

  3178. underlying curses library.</p>

  3179. </div>

  3180. <p>The following table lists the predefined colors:</p>

  3181. <table class="docutils align-default">

  3182. <thead>

  3183. <tr class="row-odd"><th class="head"><p>Constant</p></th>

  3184. <th class="head"><p>Color</p></th>

  3185. </tr>

  3186. </thead>

  3187. <tbody>

  3188. <tr class="row-even"><td><dl class="py data">

  3189. <dt class="sig sig-object py" id="curses.COLOR_BLACK">

  3190. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">COLOR_BLACK</span></span><a class="headerlink" href="#curses.COLOR_BLACK" title="Link to this definition">¶</a></dt>

  3191. <dd></dd></dl>

  3192. 

  3193. </td>

  3194. <td><p>Black</p></td>

  3195. </tr>

  3196. <tr class="row-odd"><td><dl class="py data">

  3197. <dt class="sig sig-object py" id="curses.COLOR_BLUE">

  3198. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">COLOR_BLUE</span></span><a class="headerlink" href="#curses.COLOR_BLUE" title="Link to this definition">¶</a></dt>

  3199. <dd></dd></dl>

  3200. 

  3201. </td>

  3202. <td><p>Blue</p></td>

  3203. </tr>

  3204. <tr class="row-even"><td><dl class="py data">

  3205. <dt class="sig sig-object py" id="curses.COLOR_CYAN">

  3206. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">COLOR_CYAN</span></span><a class="headerlink" href="#curses.COLOR_CYAN" title="Link to this definition">¶</a></dt>

  3207. <dd></dd></dl>

  3208. 

  3209. </td>

  3210. <td><p>Cyan (light greenish blue)</p></td>

  3211. </tr>

  3212. <tr class="row-odd"><td><dl class="py data">

  3213. <dt class="sig sig-object py" id="curses.COLOR_GREEN">

  3214. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">COLOR_GREEN</span></span><a class="headerlink" href="#curses.COLOR_GREEN" title="Link to this definition">¶</a></dt>

  3215. <dd></dd></dl>

  3216. 

  3217. </td>

  3218. <td><p>Green</p></td>

  3219. </tr>

  3220. <tr class="row-even"><td><dl class="py data">

  3221. <dt class="sig sig-object py" id="curses.COLOR_MAGENTA">

  3222. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">COLOR_MAGENTA</span></span><a class="headerlink" href="#curses.COLOR_MAGENTA" title="Link to this definition">¶</a></dt>

  3223. <dd></dd></dl>

  3224. 

  3225. </td>

  3226. <td><p>Magenta (purplish red)</p></td>

  3227. </tr>

  3228. <tr class="row-odd"><td><dl class="py data">

  3229. <dt class="sig sig-object py" id="curses.COLOR_RED">

  3230. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">COLOR_RED</span></span><a class="headerlink" href="#curses.COLOR_RED" title="Link to this definition">¶</a></dt>

  3231. <dd></dd></dl>

  3232. 

  3233. </td>

  3234. <td><p>Red</p></td>

  3235. </tr>

  3236. <tr class="row-even"><td><dl class="py data">

  3237. <dt class="sig sig-object py" id="curses.COLOR_WHITE">

  3238. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">COLOR_WHITE</span></span><a class="headerlink" href="#curses.COLOR_WHITE" title="Link to this definition">¶</a></dt>

  3239. <dd></dd></dl>

  3240. 

  3241. </td>

  3242. <td><p>White</p></td>

  3243. </tr>

  3244. <tr class="row-odd"><td><dl class="py data">

  3245. <dt class="sig sig-object py" id="curses.COLOR_YELLOW">

  3246. <span class="sig-prename descclassname"><span class="pre">curses.</span></span><span class="sig-name descname"><span class="pre">COLOR_YELLOW</span></span><a class="headerlink" href="#curses.COLOR_YELLOW" title="Link to this definition">¶</a></dt>

  3247. <dd></dd></dl>

  3248. 

  3249. </td>

  3250. <td><p>Yellow</p></td>

  3251. </tr>

  3252. </tbody>

  3253. </table>

  3254. </section>

  3255. </section>

  3256. <section id="module-curses.textpad">

  3257. <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="Link to this heading">¶</a></h1>

  3258. <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

  3259. elementary text editing in a curses window, supporting a set of keybindings

  3260. resembling those of Emacs (thus, also of Netscape Navigator, BBedit 6.x,

  3261. FrameMaker, and many other programs).  The module also provides a

  3262. rectangle-drawing function useful for framing text boxes or for other purposes.</p>

  3263. <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>

  3264. <dl class="py function">

  3265. <dt class="sig sig-object py" id="curses.textpad.rectangle">

  3266. <span class="sig-prename descclassname"><span class="pre">curses.textpad.</span></span><span class="sig-name descname"><span class="pre">rectangle</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">win</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uly</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ulx</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lry</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lrx</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.textpad.rectangle" title="Link to this definition">¶</a></dt>

  3267. <dd><p>Draw a rectangle.  The first argument must be a window object; the remaining

  3268. arguments are coordinates relative to that window.  The second and third

  3269. arguments are the y and x coordinates of the upper left hand corner of the

  3270. rectangle to be drawn; the fourth and fifth arguments are the y and x

  3271. coordinates of the lower right hand corner. The rectangle will be drawn using

  3272. VT100/IBM PC forms characters on terminals that make this possible (including

  3273. xterm and most other software terminal emulators).  Otherwise it will be drawn

  3274. with ASCII  dashes, vertical bars, and plus signs.</p>

  3275. </dd></dl>

  3276. 

  3277. <section id="textbox-objects">

  3278. <span id="curses-textpad-objects"></span><h2>Textbox objects<a class="headerlink" href="#textbox-objects" title="Link to this heading">¶</a></h2>

  3279. <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>

  3280. <dl class="py class">

  3281. <dt class="sig sig-object py" id="curses.textpad.Textbox">

  3282. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">curses.textpad.</span></span><span class="sig-name descname"><span class="pre">Textbox</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">win</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.textpad.Textbox" title="Link to this definition">¶</a></dt>

  3283. <dd><p>Return a textbox widget object.  The <em>win</em> argument should be a curses

  3284. <a class="reference internal" href="#curses-window-objects"><span class="std std-ref">window</span></a> object in which the textbox is to

  3285. be contained. The edit cursor of the textbox is initially located at the

  3286. 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>.

  3287. 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>

  3288. <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>

  3289. <dl class="py method">

  3290. <dt class="sig sig-object py" id="curses.textpad.Textbox.edit">

  3291. <span class="sig-name descname"><span class="pre">edit</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="n"><span class="pre">validator</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.textpad.Textbox.edit" title="Link to this definition">¶</a></dt>

  3292. <dd><p>This is the entry point you will normally use.  It accepts editing

  3293. keystrokes until one of the termination keystrokes is entered.  If

  3294. <em>validator</em> is supplied, it must be a function.  It will be called for

  3295. each keystroke entered with the keystroke as a parameter; command dispatch

  3296. is done on the result. This method returns the window contents as a

  3297. string; whether blanks in the window are included is affected by the

  3298. <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>

  3299. </dd></dl>

  3300. 

  3301. <dl class="py method">

  3302. <dt class="sig sig-object py" id="curses.textpad.Textbox.do_command">

  3303. <span class="sig-name descname"><span class="pre">do_command</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ch</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#curses.textpad.Textbox.do_command" title="Link to this definition">¶</a></dt>

  3304. <dd><p>Process a single command keystroke.  Here are the supported special

  3305. keystrokes:</p>

  3306. <table class="docutils align-default">

  3307. <thead>

  3308. <tr class="row-odd"><th class="head"><p>Keystroke</p></th>

  3309. <th class="head"><p>Action</p></th>

  3310. </tr>

  3311. </thead>

  3312. <tbody>

  3313. <tr class="row-even"><td><p><kbd class="kbd compound docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Control</kbd>-<kbd class="kbd docutils literal notranslate">A</kbd></kbd></p></td>

  3314. <td><p>Go to left edge of window.</p></td>

  3315. </tr>

  3316. <tr class="row-odd"><td><p><kbd class="kbd compound docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Control</kbd>-<kbd class="kbd docutils literal notranslate">B</kbd></kbd></p></td>

  3317. <td><p>Cursor left, wrapping to previous line if

  3318. appropriate.</p></td>

  3319. </tr>

  3320. <tr class="row-even"><td><p><kbd class="kbd compound docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Control</kbd>-<kbd class="kbd docutils literal notranslate">D</kbd></kbd></p></td>

  3321. <td><p>Delete character under cursor.</p></td>

  3322. </tr>

  3323. <tr class="row-odd"><td><p><kbd class="kbd compound docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Control</kbd>-<kbd class="kbd docutils literal notranslate">E</kbd></kbd></p></td>

  3324. <td><p>Go to right edge (stripspaces off) or end

  3325. of line (stripspaces on).</p></td>

  3326. </tr>

  3327. <tr class="row-even"><td><p><kbd class="kbd compound docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Control</kbd>-<kbd class="kbd docutils literal notranslate">F</kbd></kbd></p></td>

  3328. <td><p>Cursor right, wrapping to next line when

  3329. appropriate.</p></td>

  3330. </tr>

  3331. <tr class="row-odd"><td><p><kbd class="kbd compound docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Control</kbd>-<kbd class="kbd docutils literal notranslate">G</kbd></kbd></p></td>

  3332. <td><p>Terminate, returning the window contents.</p></td>

  3333. </tr>

  3334. <tr class="row-even"><td><p><kbd class="kbd compound docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Control</kbd>-<kbd class="kbd docutils literal notranslate">H</kbd></kbd></p></td>

  3335. <td><p>Delete character backward.</p></td>

  3336. </tr>

  3337. <tr class="row-odd"><td><p><kbd class="kbd compound docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Control</kbd>-<kbd class="kbd docutils literal notranslate">J</kbd></kbd></p></td>

  3338. <td><p>Terminate if the window is 1 line,

  3339. otherwise insert newline.</p></td>

  3340. </tr>

  3341. <tr class="row-even"><td><p><kbd class="kbd compound docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Control</kbd>-<kbd class="kbd docutils literal notranslate">K</kbd></kbd></p></td>

  3342. <td><p>If line is blank, delete it, otherwise

  3343. clear to end of line.</p></td>

  3344. </tr>

  3345. <tr class="row-odd"><td><p><kbd class="kbd compound docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Control</kbd>-<kbd class="kbd docutils literal notranslate">L</kbd></kbd></p></td>

  3346. <td><p>Refresh screen.</p></td>

  3347. </tr>

  3348. <tr class="row-even"><td><p><kbd class="kbd compound docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Control</kbd>-<kbd class="kbd docutils literal notranslate">N</kbd></kbd></p></td>

  3349. <td><p>Cursor down; move down one line.</p></td>

  3350. </tr>

  3351. <tr class="row-odd"><td><p><kbd class="kbd compound docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Control</kbd>-<kbd class="kbd docutils literal notranslate">O</kbd></kbd></p></td>

  3352. <td><p>Insert a blank line at cursor location.</p></td>

  3353. </tr>

  3354. <tr class="row-even"><td><p><kbd class="kbd compound docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Control</kbd>-<kbd class="kbd docutils literal notranslate">P</kbd></kbd></p></td>

  3355. <td><p>Cursor up; move up one line.</p></td>

  3356. </tr>

  3357. </tbody>

  3358. </table>

  3359. <p>Move operations do nothing if the cursor is at an edge where the movement

  3360. is not possible.  The following synonyms are supported where possible:</p>

  3361. <table class="docutils align-default">

  3362. <thead>

  3363. <tr class="row-odd"><th class="head"><p>Constant</p></th>

  3364. <th class="head"><p>Keystroke</p></th>

  3365. </tr>

  3366. </thead>

  3367. <tbody>

  3368. <tr class="row-even"><td><p><a class="reference internal" href="#curses.KEY_LEFT" title="curses.KEY_LEFT"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_LEFT</span></code></a></p></td>

  3369. <td><p><kbd class="kbd compound docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Control</kbd>-<kbd class="kbd docutils literal notranslate">B</kbd></kbd></p></td>

  3370. </tr>

  3371. <tr class="row-odd"><td><p><a class="reference internal" href="#curses.KEY_RIGHT" title="curses.KEY_RIGHT"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_RIGHT</span></code></a></p></td>

  3372. <td><p><kbd class="kbd compound docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Control</kbd>-<kbd class="kbd docutils literal notranslate">F</kbd></kbd></p></td>

  3373. </tr>

  3374. <tr class="row-even"><td><p><a class="reference internal" href="#curses.KEY_UP" title="curses.KEY_UP"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_UP</span></code></a></p></td>

  3375. <td><p><kbd class="kbd compound docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Control</kbd>-<kbd class="kbd docutils literal notranslate">P</kbd></kbd></p></td>

  3376. </tr>

  3377. <tr class="row-odd"><td><p><a class="reference internal" href="#curses.KEY_DOWN" title="curses.KEY_DOWN"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_DOWN</span></code></a></p></td>

  3378. <td><p><kbd class="kbd compound docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Control</kbd>-<kbd class="kbd docutils literal notranslate">N</kbd></kbd></p></td>

  3379. </tr>

  3380. <tr class="row-even"><td><p><a class="reference internal" href="#curses.KEY_BACKSPACE" title="curses.KEY_BACKSPACE"><code class="xref py py-const docutils literal notranslate"><span class="pre">KEY_BACKSPACE</span></code></a></p></td>

  3381. <td><p><kbd class="kbd compound docutils literal notranslate"><kbd class="kbd docutils literal notranslate">Control</kbd>-<kbd class="kbd docutils literal notranslate">h</kbd></kbd></p></td>

  3382. </tr>

  3383. </tbody>

  3384. </table>

  3385. <p>All other keystrokes are treated as a command to insert the given

  3386. character and move right (with line wrapping).</p>

  3387. </dd></dl>

  3388. 

  3389. <dl class="py method">

  3390. <dt class="sig sig-object py" id="curses.textpad.Textbox.gather">

  3391. <span class="sig-name descname"><span class="pre">gather</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#curses.textpad.Textbox.gather" title="Link to this definition">¶</a></dt>

  3392. <dd><p>Return the window contents as a string; whether blanks in the

  3393. 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>

  3394. </dd></dl>

  3395. 

  3396. <dl class="py attribute">

  3397. <dt class="sig sig-object py" id="curses.textpad.Textbox.stripspaces">

  3398. <span class="sig-name descname"><span class="pre">stripspaces</span></span><a class="headerlink" href="#curses.textpad.Textbox.stripspaces" title="Link to this definition">¶</a></dt>

  3399. <dd><p>This attribute is a flag which controls the interpretation of blanks in

  3400. the window.  When it is on, trailing blanks on each line are ignored; any

  3401. cursor motion that would land the cursor on a trailing blank goes to the

  3402. end of that line instead, and trailing blanks are stripped when the window

  3403. contents are gathered.</p>

  3404. </dd></dl>

  3405. 

  3406. </dd></dl>

  3407. 

  3408. </section>

  3409. </section>

  3410. 

  3411. 

  3412.             <div class="clearer"></div>

  3413.           </div>

  3414.         </div>

  3415.       </div>

  3416.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">

  3417.         <div class="sphinxsidebarwrapper">

  3418.   <div>

  3419.     <h3><a href="../contents.html">Table of Contents</a></h3>

  3420.     <ul>

  3421. <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>

  3422. <li><a class="reference internal" href="#functions">Functions</a></li>

  3423. <li><a class="reference internal" href="#window-objects">Window Objects</a></li>

  3424. <li><a class="reference internal" href="#constants">Constants</a></li>

  3425. </ul>

  3426. </li>

  3427. <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>

  3428. <li><a class="reference internal" href="#textbox-objects">Textbox objects</a></li>

  3429. </ul>

  3430. </li>

  3431. </ul>

  3432. 

  3433.   </div>

  3434.   <div>

  3435.     <h4>Previous topic</h4>

  3436.     <p class="topless"><a href="getpass.html"

  3437.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">getpass</span></code> — Portable password input</a></p>

  3438.   </div>

  3439.   <div>

  3440.     <h4>Next topic</h4>

  3441.     <p class="topless"><a href="curses.ascii.html"

  3442.                           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>

  3443.   </div>

  3444.   <div role="note" aria-label="source link">

  3445.     <h3>This Page</h3>

  3446.     <ul class="this-page-menu">

  3447.       <li><a href="../bugs.html">Report a Bug</a></li>

  3448.       <li>

  3449.         <a href="https://github.com/python/cpython/blob/main/Doc/library/curses.rst"

  3450.             rel="nofollow">Show Source

  3451.         </a>

  3452.       </li>

  3453.     </ul>

  3454.   </div>

  3455.         </div>

  3456. <div id="sidebarbutton" title="Collapse sidebar">

  3457. <span>«</span>

  3458. </div>

  3459. 

  3460.       </div>

  3461.       <div class="clearer"></div>

  3462.     </div>  

  3463.     <div class="related" role="navigation" aria-label="related navigation">

  3464.       <h3>Navigation</h3>

  3465.       <ul>

  3466.         <li class="right" style="margin-right: 10px">

  3467.           <a href="../genindex.html" title="General Index"

  3468.              >index</a></li>

  3469.         <li class="right" >

  3470.           <a href="../py-modindex.html" title="Python Module Index"

  3471.              >modules</a> |</li>

  3472.         <li class="right" >

  3473.           <a href="curses.ascii.html" title="curses.ascii — Utilities for ASCII characters"

  3474.              >next</a> |</li>

  3475.         <li class="right" >

  3476.           <a href="getpass.html" title="getpass — Portable password input"

  3477.              >previous</a> |</li>

  3478. 

  3479.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  3480.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  3481.           <li class="switchers">

  3482.             <div class="language_switcher_placeholder"></div>

  3483.             <div class="version_switcher_placeholder"></div>

  3484.           </li>

  3485.           <li>

  3486.               

  3487.           </li>

  3488.     <li id="cpython-language-and-version">

  3489.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  3490.     </li>

  3491. 

  3492.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  3493.           <li class="nav-item nav-item-2"><a href="allos.html" >Generic Operating System Services</a> &#187;</li>

  3494.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">curses</span></code> — Terminal handling for character-cell displays</a></li>

  3495.                 <li class="right">

  3496.                     

  3497. 

  3498.     <div class="inline-search" role="search">

  3499.         <form class="inline-search" action="../search.html" method="get">

  3500.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  3501.           <input type="submit" value="Go" />

  3502.         </form>

  3503.     </div>

  3504.                      |

  3505.                 </li>

  3506.             <li class="right">

  3507. <label class="theme-selector-label">

  3508.     Theme

  3509.     <select class="theme-selector" oninput="activateTheme(this.value)">

  3510.         <option value="auto" selected>Auto</option>

  3511.         <option value="light">Light</option>

  3512.         <option value="dark">Dark</option>

  3513.     </select>

  3514. </label> |</li>

  3515.             

  3516.       </ul>

  3517.     </div>  

  3518.     <div class="footer">

  3519.     &copy; 

  3520.       <a href="../copyright.html">

  3521.     

  3522.     Copyright

  3523.     

  3524.       </a>

  3525.      2001-2024, Python Software Foundation.

  3526.     <br />

  3527.     This page is licensed under the Python Software Foundation License Version 2.

  3528.     <br />

  3529.     Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.

  3530.     <br />

  3531.     

  3532.       See <a href="/license.html">History and License</a> for more information.<br />

  3533.     

  3534.     

  3535.     <br />

  3536. 

  3537.     The Python Software Foundation is a non-profit corporation.

  3538. <a href="https://www.python.org/psf/donations/">Please donate.</a>

  3539. <br />

  3540.     <br />

  3541.       Last updated on Apr 09, 2024 (13:47 UTC).

  3542.     

  3543.       <a href="/bugs.html">Found a bug</a>?

  3544.     

  3545.     <br />

  3546. 

  3547.     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

  3548.     </div>

  3549. 

  3550.   </body>

  3551. </html>
上海开阖软件有限公司 沪ICP备12045867号-1