~dkuhlman/python-training-materials/Materials

<h1>15.11. <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">curses</code></a> — Terminal handling for character-cell displays<a class="headerlink" href="#module-curses" title="Permalink to this headline">¶</a></h1>

Changed in version 1.6: Added support for the <code class="docutils literal">ncurses</code> library and converted to a package.

</div>

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">curses</code></a> 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 environment, versions are available

for DOS, OS/2, and possibly other systems as well. This extension module is

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

Linux and the BSD variants of Unix.

Note

Since version 5.4, the ncurses library decides how to interpret non-ASCII data

using the <code class="docutils literal">nl_langinfo</code> function. That means that you have to call

<a class="reference internal" href="locale.html#locale.setlocale" title="locale.setlocale"><code class="xref py py-func docutils literal">locale.setlocale()</code></a> in the application and encode Unicode strings

using one of the system’s available encodings. This example uses the

system’s default encoding:

<div class="highlight-python"><div class="highlight"><pre>import locale

locale.setlocale(locale.LC_ALL, '')

code = locale.getpreferredencoding()

</pre></div>

</div>

100

Then use code as the encoding for <a class="reference internal" href="stdtypes.html#str.encode" title="str.encode"><code class="xref py py-meth docutils literal">str.encode()</code></a> calls.

101

</div>

102

103

See also

104

105

<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">curses.ascii</code></a></dt>

106

<dd>Utilities for working with ASCII characters, regardless of your locale settings.</dd>

107

<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">curses.panel</code></a></dt>

108

<dd>A panel stack extension that adds depth to curses windows.</dd>

109

<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">curses.textpad</code></a></dt>

110

<dd>Editable text widget for curses supporting Emacs-like bindings.</dd>

111

<dt><a class="reference internal" href="../howto/curses.html#curses-howto">Curses Programming with Python</a></dt>

112

<dd>Tutorial material on using curses with Python, by Andrew Kuchling and Eric

113

Raymond.</dd>

114

</dl>

115

The <a class="reference external" href="https://hg.python.org/cpython/file/2.7/Demo/curses/">Demo/curses/</a> directory in the Python source distribution contains

116

some example programs using the curses bindings provided by this module.

117

</div>

118

119

<h2>15.11.1. Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h2>

120

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">curses</code></a> defines the following exception:

121

122

123

exception <code class="descclassname">curses.</code><code class="descname">error</code><a class="headerlink" href="#curses.error" title="Permalink to this definition">¶</a></dt>

124

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

125

</dd></dl>

126

127

128

Note

129

Whenever x or y arguments to a function or a method are optional, they

130

default to the current cursor location. Whenever attr is optional, it defaults

131

to <code class="xref py py-const docutils literal">A_NORMAL</code>.

132

</div>

133

134

135

136

<code class="descclassname">curses.</code><code class="descname">baudrate</code>()<a class="headerlink" href="#curses.baudrate" title="Permalink to this definition">¶</a></dt>

137

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

138

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

139

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

140

occasionally to change interfaces depending on the line speed.

141

</dd></dl>

142

143

144

145

<code class="descclassname">curses.</code><code class="descname">beep</code>()<a class="headerlink" href="#curses.beep" title="Permalink to this definition">¶</a></dt>

146

<dd>Emit a short attention sound.

147

</dd></dl>

148

149

150

151

<code class="descclassname">curses.</code><code class="descname">can_change_color</code>()<a class="headerlink" href="#curses.can_change_color" title="Permalink to this definition">¶</a></dt>

152

<dd>Return <code class="docutils literal">True</code> or <code class="docutils literal">False</code>, depending on whether the programmer can change the colors

153

displayed by the terminal.

154

</dd></dl>

155

156

157

158

<code class="descclassname">curses.</code><code class="descname">cbreak</code>()<a class="headerlink" href="#curses.cbreak" title="Permalink to this definition">¶</a></dt>

159

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

160

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

161

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

162

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

163

first <a class="reference internal" href="#curses.raw" title="curses.raw"><code class="xref py py-func docutils literal">raw()</code></a> then <a class="reference internal" href="#curses.cbreak" title="curses.cbreak"><code class="xref py py-func docutils literal">cbreak()</code></a> leaves the terminal in cbreak mode.

164

</dd></dl>

165

166

167

168

<code class="descclassname">curses.</code><code class="descname">color_content</code>(color_number)<a class="headerlink" href="#curses.color_content" title="Permalink to this definition">¶</a></dt>

169

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

170

color_number, which must be between <code class="docutils literal">0</code> and <code class="xref py py-const docutils literal">COLORS</code>. A 3-tuple is

171

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

172

<code class="docutils literal">0</code> (no component) and <code class="docutils literal">1000</code> (maximum amount of component).

173

</dd></dl>

174

175

176

177

<code class="descclassname">curses.</code><code class="descname">color_pair</code>(color_number)<a class="headerlink" href="#curses.color_pair" title="Permalink to this definition">¶</a></dt>

178

<dd>Return the attribute value for displaying text in the specified color. This

179

attribute value can be combined with <code class="xref py py-const docutils literal">A_STANDOUT</code>, <code class="xref py py-const docutils literal">A_REVERSE</code>,

180

and the other <code class="xref py py-const docutils literal">A_*</code> attributes. <a class="reference internal" href="#curses.pair_number" title="curses.pair_number"><code class="xref py py-func docutils literal">pair_number()</code></a> is the counterpart

181

to this function.

182

</dd></dl>

183

184

185

186

<code class="descclassname">curses.</code><code class="descname">curs_set</code>(visibility)<a class="headerlink" href="#curses.curs_set" title="Permalink to this definition">¶</a></dt>

187

<dd>Set the cursor state. visibility can be set to 0, 1, or 2, for invisible,

188

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

189

previous cursor state is returned; otherwise, an exception is raised. On many

190

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

191

is a block cursor.

192

</dd></dl>

193

194

195

196

<code class="descclassname">curses.</code><code class="descname">def_prog_mode</code>()<a class="headerlink" href="#curses.def_prog_mode" title="Permalink to this definition">¶</a></dt>

197

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

198

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

199

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">reset_prog_mode()</code></a> will

200

restore this mode.

201

</dd></dl>

202

203

204

205

<code class="descclassname">curses.</code><code class="descname">def_shell_mode</code>()<a class="headerlink" href="#curses.def_shell_mode" title="Permalink to this definition">¶</a></dt>

206

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

207

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

208

program is using curses capabilities.) Subsequent calls to

209

<a class="reference internal" href="#curses.reset_shell_mode" title="curses.reset_shell_mode"><code class="xref py py-func docutils literal">reset_shell_mode()</code></a> will restore this mode.

210

</dd></dl>

211

212

213

214

<code class="descclassname">curses.</code><code class="descname">delay_output</code>(ms)<a class="headerlink" href="#curses.delay_output" title="Permalink to this definition">¶</a></dt>

215

<dd>Insert an ms millisecond pause in output.

216

</dd></dl>

217

218

219

220

<code class="descclassname">curses.</code><code class="descname">doupdate</code>()<a class="headerlink" href="#curses.doupdate" title="Permalink to this definition">¶</a></dt>

221

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

222

representing the current physical screen contents and a virtual screen

223

representing the desired next state. The <a class="reference internal" href="#curses.doupdate" title="curses.doupdate"><code class="xref py py-func docutils literal">doupdate()</code></a> ground updates the

224

physical screen to match the virtual screen.

225

The virtual screen may be updated by a <code class="xref py py-meth docutils literal">noutrefresh()</code> call after write

226

operations such as <code class="xref py py-meth docutils literal">addstr()</code> have been performed on a window. The normal

227

<code class="xref py py-meth docutils literal">refresh()</code> call is simply <code class="xref py py-meth docutils literal">noutrefresh()</code> followed by <a class="reference internal" href="#curses.doupdate" title="curses.doupdate"><code class="xref py py-func docutils literal">doupdate()</code></a>;

228

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

229

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

230

followed by a single <a class="reference internal" href="#curses.doupdate" title="curses.doupdate"><code class="xref py py-func docutils literal">doupdate()</code></a>.

231

</dd></dl>

232

233

234

235

<code class="descclassname">curses.</code><code class="descname">echo</code>()<a class="headerlink" href="#curses.echo" title="Permalink to this definition">¶</a></dt>

236

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

237

it is entered.

238

</dd></dl>

239

240

241

242

<code class="descclassname">curses.</code><code class="descname">endwin</code>()<a class="headerlink" href="#curses.endwin" title="Permalink to this definition">¶</a></dt>

243

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

244

</dd></dl>

245

246

247

248

<code class="descclassname">curses.</code><code class="descname">erasechar</code>()<a class="headerlink" href="#curses.erasechar" title="Permalink to this definition">¶</a></dt>

249

<dd>Return the user’s current erase character. Under Unix operating systems this

250

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

251

the curses library itself.

252

</dd></dl>

253

254

255

256

<code class="descclassname">curses.</code><code class="descname">filter</code>()<a class="headerlink" href="#curses.filter" title="Permalink to this definition">¶</a></dt>

257

<dd>The <a class="reference internal" href="#curses.filter" title="curses.filter"><code class="xref py py-func docutils literal">filter()</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">initscr()</code></a> is

258

called. The effect is that, during those calls, <code class="xref std std-envvar docutils literal">LINES</code> is set to 1; the

259

capabilities clear, cup, cud, cud1, cuu1, cuu, vpa are disabled; and the home

260

string is set to the value of cr. The effect is that the cursor is confined to

261

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

262

character-at-a-time line editing without touching the rest of the screen.

263

</dd></dl>

264

265

266

267

<code class="descclassname">curses.</code><code class="descname">flash</code>()<a class="headerlink" href="#curses.flash" title="Permalink to this definition">¶</a></dt>

268

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

269

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

270

attention signal produced by <a class="reference internal" href="#curses.beep" title="curses.beep"><code class="xref py py-func docutils literal">beep()</code></a>.

271

</dd></dl>

272

273

274

275

<code class="descclassname">curses.</code><code class="descname">flushinp</code>()<a class="headerlink" href="#curses.flushinp" title="Permalink to this definition">¶</a></dt>

276

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

277

by the user and has not yet been processed by the program.

278

</dd></dl>

279

280

281

282

<code class="descclassname">curses.</code><code class="descname">getmouse</code>()<a class="headerlink" href="#curses.getmouse" title="Permalink to this definition">¶</a></dt>

283

<dd>After <code class="xref py py-meth docutils literal">getch()</code> returns <code class="xref py py-const docutils literal">KEY_MOUSE</code> to signal a mouse event, this

284

method should be call to retrieve the queued mouse event, represented as a

285

5-tuple <code class="docutils literal">(id, x, y, z, bstate)</code>. id is an ID value used to distinguish

286

multiple devices, and x, y, z are the event’s coordinates. (z is

287

currently unused.) bstate is an integer value whose bits will be set to

288

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

289

following constants, where n is the button number from 1 to 4:

290

<code class="xref py py-const docutils literal">BUTTONn_PRESSED</code>, <code class="xref py py-const docutils literal">BUTTONn_RELEASED</code>, <code class="xref py py-const docutils literal">BUTTONn_CLICKED</code>,

291

<code class="xref py py-const docutils literal">BUTTONn_DOUBLE_CLICKED</code>, <code class="xref py py-const docutils literal">BUTTONn_TRIPLE_CLICKED</code>,

292

<code class="xref py py-const docutils literal">BUTTON_SHIFT</code>, <code class="xref py py-const docutils literal">BUTTON_CTRL</code>, <code class="xref py py-const docutils literal">BUTTON_ALT</code>.

293

</dd></dl>

294

295

296

297

<code class="descclassname">curses.</code><code class="descname">getsyx</code>()<a class="headerlink" href="#curses.getsyx" title="Permalink to this definition">¶</a></dt>

298

<dd>Return the current coordinates of the virtual screen cursor in y and x. If

299

leaveok is currently true, then -1,-1 is returned.

300

</dd></dl>

301

302

303

304

<code class="descclassname">curses.</code><code class="descname">getwin</code>(file)<a class="headerlink" href="#curses.getwin" title="Permalink to this definition">¶</a></dt>

305

<dd>Read window related data stored in the file by an earlier <code class="xref py py-func docutils literal">putwin()</code> call.

306

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

307

the new window object.

308

</dd></dl>

309

310

311

312

<code class="descclassname">curses.</code><code class="descname">has_colors</code>()<a class="headerlink" href="#curses.has_colors" title="Permalink to this definition">¶</a></dt>

313

<dd>Return <code class="docutils literal">True</code> if the terminal can display colors; otherwise, return <code class="docutils literal">False</code>.

314

</dd></dl>

315

316

317

318

<code class="descclassname">curses.</code><code class="descname">has_ic</code>()<a class="headerlink" href="#curses.has_ic" title="Permalink to this definition">¶</a></dt>

319

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

320

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

321

terminal emulators have such capabilities.

322

</dd></dl>

323

324

325

326

<code class="descclassname">curses.</code><code class="descname">has_il</code>()<a class="headerlink" href="#curses.has_il" title="Permalink to this definition">¶</a></dt>

327

<dd>Return <code class="docutils literal">True</code> if the terminal has insert- and delete-line capabilities, or can

328

simulate them using scrolling regions. This function is included for

329

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

330

capabilities.

331

</dd></dl>

332

333

334

335

<code class="descclassname">curses.</code><code class="descname">has_key</code>(ch)<a class="headerlink" href="#curses.has_key" title="Permalink to this definition">¶</a></dt>

336

<dd>Take a key value ch, and return <code class="docutils literal">True</code> if the current terminal type recognizes

337

a key with that value.

338

</dd></dl>

339

340

341

342

<code class="descclassname">curses.</code><code class="descname">halfdelay</code>(tenths)<a class="headerlink" href="#curses.halfdelay" title="Permalink to this definition">¶</a></dt>

343

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

344

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

345

blocking for tenths tenths of seconds, an exception is raised if nothing has

346

been typed. The value of tenths must be a number between <code class="docutils literal">1</code> and <code class="docutils literal">255</code>. Use

347

<a class="reference internal" href="#curses.nocbreak" title="curses.nocbreak"><code class="xref py py-func docutils literal">nocbreak()</code></a> to leave half-delay mode.

348

</dd></dl>

349

350

351

352

<code class="descclassname">curses.</code><code class="descname">init_color</code>(color_number, r, g, b)<a class="headerlink" href="#curses.init_color" title="Permalink to this definition">¶</a></dt>

353

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

354

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

355

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

356

<code class="xref py py-const docutils literal">COLORS</code>. Each of r, g, b, must be a value between <code class="docutils literal">0</code> and

357

<code class="docutils literal">1000</code>. When <a class="reference internal" href="#curses.init_color" title="curses.init_color"><code class="xref py py-func docutils literal">init_color()</code></a> is used, all occurrences of that color on the

358

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

359

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">can_change_color()</code></a> returns <code class="docutils literal">1</code>.

360

</dd></dl>

361

362

363

364

<code class="descclassname">curses.</code><code class="descname">init_pair</code>(pair_number, fg, bg)<a class="headerlink" href="#curses.init_pair" title="Permalink to this definition">¶</a></dt>

365

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

366

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

367

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

368

<code class="docutils literal">COLOR_PAIRS - 1</code> (the <code class="docutils literal">0</code> color pair is wired to white on black and cannot

369

be changed). The value of fg and bg arguments must be between <code class="docutils literal">0</code> and

370

<code class="xref py py-const docutils literal">COLORS</code>. If the color-pair was previously initialized, the screen is

371

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

372

definition.

373

</dd></dl>

374

375

376

377

<code class="descclassname">curses.</code><code class="descname">initscr</code>()<a class="headerlink" href="#curses.initscr" title="Permalink to this definition">¶</a></dt>

378

<dd>Initialize the library. Return a <code class="xref py py-class docutils literal">WindowObject</code> which represents the

379

whole screen.

380

381

Note

382

If there is an error opening the terminal, the underlying curses library may

383

cause the interpreter to exit.

384

</div>

385

</dd></dl>

386

387

388

389

<code class="descclassname">curses.</code><code class="descname">is_term_resized</code>(nlines, ncols)<a class="headerlink" href="#curses.is_term_resized" title="Permalink to this definition">¶</a></dt>

390

<dd>Return <code class="docutils literal">True</code> if <a class="reference internal" href="#curses.resize_term" title="curses.resize_term"><code class="xref py py-func docutils literal">resize_term()</code></a> would modify the window structure,

391

<code class="docutils literal">False</code> otherwise.

392

</dd></dl>

393

394

395

396

<code class="descclassname">curses.</code><code class="descname">isendwin</code>()<a class="headerlink" href="#curses.isendwin" title="Permalink to this definition">¶</a></dt>

397

<dd>Return <code class="docutils literal">True</code> if <a class="reference internal" href="#curses.endwin" title="curses.endwin"><code class="xref py py-func docutils literal">endwin()</code></a> has been called (that is, the curses library has

398

been deinitialized).

399

</dd></dl>

400

401

402

403

<code class="descclassname">curses.</code><code class="descname">keyname</code>(k)<a class="headerlink" href="#curses.keyname" title="Permalink to this definition">¶</a></dt>

404

<dd>Return the name of the key numbered k. The name of a key generating printable

405

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

406

is a two-character string consisting of a caret followed by the corresponding

407

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

408

string consisting of the prefix ‘M-‘ followed by the name of the corresponding

409

ASCII character.

410

</dd></dl>

411

412

413

414

<code class="descclassname">curses.</code><code class="descname">killchar</code>()<a class="headerlink" href="#curses.killchar" title="Permalink to this definition">¶</a></dt>

415

<dd>Return the user’s current line kill character. Under Unix operating systems

416

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

417

by the curses library itself.

418

</dd></dl>

419

420

421

422

<code class="descclassname">curses.</code><code class="descname">longname</code>()<a class="headerlink" href="#curses.longname" title="Permalink to this definition">¶</a></dt>

423

<dd>Return a string containing the terminfo long name field describing the current

424

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

425

defined only after the call to <a class="reference internal" href="#curses.initscr" title="curses.initscr"><code class="xref py py-func docutils literal">initscr()</code></a>.

426

</dd></dl>

427

428

429

430

<code class="descclassname">curses.</code><code class="descname">meta</code>(yes)<a class="headerlink" href="#curses.meta" title="Permalink to this definition">¶</a></dt>

431

<dd>If yes is 1, allow 8-bit characters to be input. If yes is 0, allow only

432

7-bit chars.

433

</dd></dl>

434

435

436

437

<code class="descclassname">curses.</code><code class="descname">mouseinterval</code>(interval)<a class="headerlink" href="#curses.mouseinterval" title="Permalink to this definition">¶</a></dt>

438

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

439

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

440

interval value. The default value is 200 msec, or one fifth of a second.

441

</dd></dl>

442

443

444

445

<code class="descclassname">curses.</code><code class="descname">mousemask</code>(mousemask)<a class="headerlink" href="#curses.mousemask" title="Permalink to this definition">¶</a></dt>

446

<dd>Set the mouse events to be reported, and return a tuple <code class="docutils literal">(availmask,

447

oldmask)</code>. availmask indicates which of the specified mouse events can be

448

reported; on complete failure it returns 0. oldmask is the previous value of

449

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

450

events are ever reported.

451

</dd></dl>

452

453

454

455

<code class="descclassname">curses.</code><code class="descname">napms</code>(ms)<a class="headerlink" href="#curses.napms" title="Permalink to this definition">¶</a></dt>

456

<dd>Sleep for ms milliseconds.

457

</dd></dl>

458

459

460

461

<code class="descclassname">curses.</code><code class="descname">newpad</code>(nlines, ncols)<a class="headerlink" href="#curses.newpad" title="Permalink to this definition">¶</a></dt>

462

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

463

of lines and columns. A pad is returned as a window object.

464

A pad is like a window, except that it is not restricted by the screen size, and

465

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

466

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

467

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

468

echoing of input) do not occur. The <code class="xref py py-meth docutils literal">refresh()</code> and <code class="xref py py-meth docutils literal">noutrefresh()</code>

469

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

470

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

471

arguments are pminrow, pmincol, sminrow, smincol, smaxrow, smaxcol; the p

472

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

473

the s arguments define a clipping box on the screen within which the pad region

474

is to be displayed.

475

</dd></dl>

476

477

478

479

<code class="descclassname">curses.</code><code class="descname">newwin</code>(nlines, ncols)<a class="headerlink" href="#curses.newwin" title="Permalink to this definition">¶</a></dt>

480

<dt>

481

<code class="descclassname">curses.</code><code class="descname">newwin</code>(nlines, ncols, begin_y, begin_x)</dt>

482

<dd>Return a new window, whose left-upper corner is at <code class="docutils literal">(begin_y, begin_x)</code>, and

483

whose height/width is nlines/ncols.

484

By default, the window will extend from the specified position to the lower

485

right corner of the screen.

486

</dd></dl>

487

488

489

490

<code class="descclassname">curses.</code><code class="descname">nl</code>()<a class="headerlink" href="#curses.nl" title="Permalink to this definition">¶</a></dt>

491

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

492

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

493

initially on.

494

</dd></dl>

495

496

497

498

<code class="descclassname">curses.</code><code class="descname">nocbreak</code>()<a class="headerlink" href="#curses.nocbreak" title="Permalink to this definition">¶</a></dt>

499

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

500

</dd></dl>

501

502

503

504

<code class="descclassname">curses.</code><code class="descname">noecho</code>()<a class="headerlink" href="#curses.noecho" title="Permalink to this definition">¶</a></dt>

505

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

506

</dd></dl>

507

508

509

510

<code class="descclassname">curses.</code><code class="descname">nonl</code>()<a class="headerlink" href="#curses.nonl" title="Permalink to this definition">¶</a></dt>

511

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

512

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

513

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

514

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

515

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

516

able to detect the return key on input.

517

</dd></dl>

518

519

520

521

<code class="descclassname">curses.</code><code class="descname">noqiflush</code>()<a class="headerlink" href="#curses.noqiflush" title="Permalink to this definition">¶</a></dt>

522

<dd>When the <a class="reference internal" href="#curses.noqiflush" title="curses.noqiflush"><code class="xref py py-func docutils literal">noqiflush()</code></a> routine is used, normal flush of input and output queues

523

associated with the INTR, QUIT and SUSP characters will not be done. You may

524

want to call <a class="reference internal" href="#curses.noqiflush" title="curses.noqiflush"><code class="xref py py-func docutils literal">noqiflush()</code></a> in a signal handler if you want output to

525

continue as though the interrupt had not occurred, after the handler exits.

526

</dd></dl>

527

528

529

530

<code class="descclassname">curses.</code><code class="descname">noraw</code>()<a class="headerlink" href="#curses.noraw" title="Permalink to this definition">¶</a></dt>

531

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

532

</dd></dl>

533

534

535

536

<code class="descclassname">curses.</code><code class="descname">pair_content</code>(pair_number)<a class="headerlink" href="#curses.pair_content" title="Permalink to this definition">¶</a></dt>

537

<dd>Return a tuple <code class="docutils literal">(fg, bg)</code> containing the colors for the requested color pair.

538

The value of pair_number must be between <code class="docutils literal">1</code> and <code class="docutils literal">COLOR_PAIRS - 1</code>.

539

</dd></dl>

540

541

542

543

<code class="descclassname">curses.</code><code class="descname">pair_number</code>(attr)<a class="headerlink" href="#curses.pair_number" title="Permalink to this definition">¶</a></dt>

544

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

545

<a class="reference internal" href="#curses.color_pair" title="curses.color_pair"><code class="xref py py-func docutils literal">color_pair()</code></a> is the counterpart to this function.

546

</dd></dl>

547

548

549

550

<code class="descclassname">curses.</code><code class="descname">putp</code>(string)<a class="headerlink" href="#curses.putp" title="Permalink to this definition">¶</a></dt>

551

<dd>Equivalent to <code class="docutils literal">tputs(str, 1, putchar)</code>; emit the value of a specified

552

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">putp()</code></a>

553

always goes to standard output.

554

</dd></dl>

555

556

557

558

<code class="descclassname">curses.</code><code class="descname">qiflush</code>([flag])<a class="headerlink" href="#curses.qiflush" title="Permalink to this definition">¶</a></dt>

559

<dd>If flag is <code class="docutils literal">False</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">noqiflush()</code></a>. If

560

flag is <code class="docutils literal">True</code>, or no argument is provided, the queues will be flushed when

561

these control characters are read.

562

</dd></dl>

563

564

565

566

<code class="descclassname">curses.</code><code class="descname">raw</code>()<a class="headerlink" href="#curses.raw" title="Permalink to this definition">¶</a></dt>

567

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

568

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

569

presented to curses input functions one by one.

570

</dd></dl>

571

572

573

574

<code class="descclassname">curses.</code><code class="descname">reset_prog_mode</code>()<a class="headerlink" href="#curses.reset_prog_mode" title="Permalink to this definition">¶</a></dt>

575

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

576

<a class="reference internal" href="#curses.def_prog_mode" title="curses.def_prog_mode"><code class="xref py py-func docutils literal">def_prog_mode()</code></a>.

577

</dd></dl>

578

579

580

581

<code class="descclassname">curses.</code><code class="descname">reset_shell_mode</code>()<a class="headerlink" href="#curses.reset_shell_mode" title="Permalink to this definition">¶</a></dt>

582

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

583

<a class="reference internal" href="#curses.def_shell_mode" title="curses.def_shell_mode"><code class="xref py py-func docutils literal">def_shell_mode()</code></a>.

584

</dd></dl>

585

586

587

588

<code class="descclassname">curses.</code><code class="descname">resetty</code>()<a class="headerlink" href="#curses.resetty" title="Permalink to this definition">¶</a></dt>

589

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

590

<a class="reference internal" href="#curses.savetty" title="curses.savetty"><code class="xref py py-func docutils literal">savetty()</code></a>.

591

</dd></dl>

592

593

594

595

<code class="descclassname">curses.</code><code class="descname">resize_term</code>(nlines, ncols)<a class="headerlink" href="#curses.resize_term" title="Permalink to this definition">¶</a></dt>

596

<dd>Backend function used by <a class="reference internal" href="#curses.resizeterm" title="curses.resizeterm"><code class="xref py py-func docutils literal">resizeterm()</code></a>, performing most of the work;

597

when resizing the windows, <a class="reference internal" href="#curses.resize_term" title="curses.resize_term"><code class="xref py py-func docutils literal">resize_term()</code></a> blank-fills the areas that are

598

extended. The calling application should fill in these areas with

599

appropriate data. The <a class="reference internal" href="#curses.resize_term" title="curses.resize_term"><code class="xref py py-func docutils literal">resize_term()</code></a> function attempts to resize all

600

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

601

to resize these without additional interaction with the application.

602

</dd></dl>

603

604

605

606

<code class="descclassname">curses.</code><code class="descname">resizeterm</code>(nlines, ncols)<a class="headerlink" href="#curses.resizeterm" title="Permalink to this definition">¶</a></dt>

607

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

608

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

609

window dimensions (in particular the SIGWINCH handler).

610

</dd></dl>

611

612

613

614

<code class="descclassname">curses.</code><code class="descname">savetty</code>()<a class="headerlink" href="#curses.savetty" title="Permalink to this definition">¶</a></dt>

615

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

616

<a class="reference internal" href="#curses.resetty" title="curses.resetty"><code class="xref py py-func docutils literal">resetty()</code></a>.

617

</dd></dl>

618

619

620

621

<code class="descclassname">curses.</code><code class="descname">setsyx</code>(y, x)<a class="headerlink" href="#curses.setsyx" title="Permalink to this definition">¶</a></dt>

622

<dd>Set the virtual screen cursor to y, x. If y and x are both -1, then

623

leaveok is set.

624

</dd></dl>

625

626

627

628

<code class="descclassname">curses.</code><code class="descname">setupterm</code>([termstr, fd])<a class="headerlink" href="#curses.setupterm" title="Permalink to this definition">¶</a></dt>

629

<dd>Initialize the terminal. termstr is a string giving the terminal name; if

630

omitted, the value of the <code class="xref std std-envvar docutils literal">TERM</code> environment variable will be used. fd is the

631

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

632

supplied, the file descriptor for <code class="docutils literal">sys.stdout</code> will be used.

633

</dd></dl>

634

635

636

637

<code class="descclassname">curses.</code><code class="descname">start_color</code>()<a class="headerlink" href="#curses.start_color" title="Permalink to this definition">¶</a></dt>

638

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

639

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

640

after <a class="reference internal" href="#curses.initscr" title="curses.initscr"><code class="xref py py-func docutils literal">initscr()</code></a>.

641

<a class="reference internal" href="#curses.start_color" title="curses.start_color"><code class="xref py py-func docutils literal">start_color()</code></a> initializes eight basic colors (black, red, green, yellow,

642

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">curses</code></a>

643

module, <code class="xref py py-const docutils literal">COLORS</code> and <code class="xref py py-const docutils literal">COLOR_PAIRS</code>, containing the maximum number

644

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

645

on the terminal to the values they had when the terminal was just turned on.

646

</dd></dl>

647

648

649

650

<code class="descclassname">curses.</code><code class="descname">termattrs</code>()<a class="headerlink" href="#curses.termattrs" title="Permalink to this definition">¶</a></dt>

651

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

652

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

653

appearance of the screen.

654

</dd></dl>

655

656

657

658

<code class="descclassname">curses.</code><code class="descname">termname</code>()<a class="headerlink" href="#curses.termname" title="Permalink to this definition">¶</a></dt>

659

<dd>Return the value of the environment variable <code class="xref std std-envvar docutils literal">TERM</code>, truncated to 14 characters.

660

</dd></dl>

661

662

663

664

<code class="descclassname">curses.</code><code class="descname">tigetflag</code>(capname)<a class="headerlink" href="#curses.tigetflag" title="Permalink to this definition">¶</a></dt>

665

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

666

capability name capname. The value <code class="docutils literal">-1</code> is returned if capname is not a

667

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

668

description.

669

</dd></dl>

670

671

672

673

<code class="descclassname">curses.</code><code class="descname">tigetnum</code>(capname)<a class="headerlink" href="#curses.tigetnum" title="Permalink to this definition">¶</a></dt>

674

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

675

capability name capname. The value <code class="docutils literal">-2</code> is returned if capname is not a

676

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

677

description.

678

</dd></dl>

679

680

681

682

<code class="descclassname">curses.</code><code class="descname">tigetstr</code>(capname)<a class="headerlink" href="#curses.tigetstr" title="Permalink to this definition">¶</a></dt>

683

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

684

capability name capname. <code class="docutils literal">None</code> is returned if capname is not a string

685

capability, or is canceled or absent from the terminal description.

686

</dd></dl>

687

688

689

690

<code class="descclassname">curses.</code><code class="descname">tparm</code>(str[, ...])<a class="headerlink" href="#curses.tparm" title="Permalink to this definition">¶</a></dt>

691

<dd>Instantiate the string str with the supplied parameters, where str should

692

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

693

<code class="docutils literal">tparm(tigetstr("cup"), 5, 3)</code> could result in <code class="docutils literal">'\033[6;4H'</code>, the exact

694

result depending on terminal type.

695

</dd></dl>

696

697

698

699

<code class="descclassname">curses.</code><code class="descname">typeahead</code>(fd)<a class="headerlink" href="#curses.typeahead" title="Permalink to this definition">¶</a></dt>

700

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

701

is <code class="docutils literal">-1</code>, then no typeahead checking is done.

702

The curses library does “line-breakout optimization” by looking for typeahead

703

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

704

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

705

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

706

allows specifying a different file descriptor for typeahead checking.

707

</dd></dl>

708

709

710

711

<code class="descclassname">curses.</code><code class="descname">unctrl</code>(ch)<a class="headerlink" href="#curses.unctrl" title="Permalink to this definition">¶</a></dt>

712

<dd>Return a string which is a printable representation of the character ch.

713

Control characters are displayed as a caret followed by the character, for

714

example as <code class="docutils literal">^C</code>. Printing characters are left as they are.

715

</dd></dl>

716

717

718

719

<code class="descclassname">curses.</code><code class="descname">ungetch</code>(ch)<a class="headerlink" href="#curses.ungetch" title="Permalink to this definition">¶</a></dt>

720

<dd>Push ch so the next <code class="xref py py-meth docutils literal">getch()</code> will return it.

721

722

Note

723

Only one ch can be pushed before <code class="xref py py-meth docutils literal">getch()</code> is called.

724

</div>

725

</dd></dl>

726

727

728

729

<code class="descclassname">curses.</code><code class="descname">ungetmouse</code>(id, x, y, z, bstate)<a class="headerlink" href="#curses.ungetmouse" title="Permalink to this definition">¶</a></dt>

730

<dd>Push a <code class="xref py py-const docutils literal">KEY_MOUSE</code> event onto the input queue, associating the given

731

state data with it.

732

</dd></dl>

733

734

735

736

<code class="descclassname">curses.</code><code class="descname">use_env</code>(flag)<a class="headerlink" href="#curses.use_env" title="Permalink to this definition">¶</a></dt>

737

<dd>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">initscr()</code></a> or newterm are

738

called. When flag is <code class="docutils literal">False</code>, the values of lines and columns specified in the

739

terminfo database will be used, even if environment variables <code class="xref std std-envvar docutils literal">LINES</code>

740

and <code class="xref std std-envvar docutils literal">COLUMNS</code> (used by default) are set, or if curses is running in a

741

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

742

<code class="xref std std-envvar docutils literal">LINES</code> and <code class="xref std std-envvar docutils literal">COLUMNS</code> are not set).

743

</dd></dl>

744

745

746

747

<code class="descclassname">curses.</code><code class="descname">use_default_colors</code>()<a class="headerlink" href="#curses.use_default_colors" title="Permalink to this definition">¶</a></dt>

748

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

749

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

750

to the color number -1. After calling this function, <code class="docutils literal">init_pair(x,

751

curses.COLOR_RED, -1)</code> initializes, for instance, color pair x to a red

752

foreground color on the default background.

753

</dd></dl>

754

755

756

757

<code class="descclassname">curses.</code><code class="descname">wrapper</code>(func, ...)<a class="headerlink" href="#curses.wrapper" title="Permalink to this definition">¶</a></dt>

758

<dd>Initialize curses and call another callable object, func, which should be the

759

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

760

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

761

exception and generating a traceback. The callable object func is then passed

762

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

763

passed to <a class="reference internal" href="#curses.wrapper" title="curses.wrapper"><code class="xref py py-func docutils literal">wrapper()</code></a>. Before calling func, <a class="reference internal" href="#curses.wrapper" title="curses.wrapper"><code class="xref py py-func docutils literal">wrapper()</code></a> turns on

764

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

765

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

766

it restores cooked mode, turns on echo, and disables the terminal keypad.

767

</dd></dl>

768

769

</div>

770

771

<h2>15.11.2. Window Objects<a class="headerlink" href="#window-objects" title="Permalink to this headline">¶</a></h2>

772

Window objects, as returned by <a class="reference internal" href="#curses.initscr" title="curses.initscr"><code class="xref py py-func docutils literal">initscr()</code></a> and <a class="reference internal" href="#curses.newwin" title="curses.newwin"><code class="xref py py-func docutils literal">newwin()</code></a> above, have

773

the following methods:

774

775

776

<code class="descclassname">window.</code><code class="descname">addch</code>(ch[, attr])<a class="headerlink" href="#curses.window.addch" title="Permalink to this definition">¶</a></dt>

777

<dt>

778

<code class="descclassname">window.</code><code class="descname">addch</code>(y, x, ch[, attr])</dt>

779

780

Note

781

A character means a C character (an ASCII code), rather than a Python

782

character (a string of length 1). (This note is true whenever the

783

documentation mentions a character.) The built-in <a class="reference internal" href="functions.html#ord" title="ord"><code class="xref py py-func docutils literal">ord()</code></a> is handy for

784

conveying strings to codes.

785

</div>

786

Paint character ch at <code class="docutils literal">(y, x)</code> with attributes attr, overwriting any

787

character previously painter at that location. By default, the character

788

position and attributes are the current settings for the window object.

789

</dd></dl>

790

791

792

793

<code class="descclassname">window.</code><code class="descname">addnstr</code>(str, n[, attr])<a class="headerlink" href="#curses.window.addnstr" title="Permalink to this definition">¶</a></dt>

794

<dt>

795

<code class="descclassname">window.</code><code class="descname">addnstr</code>(y, x, str, n[, attr])</dt>

796

<dd>Paint at most n characters of the string str at <code class="docutils literal">(y, x)</code> with attributes

797

attr, overwriting anything previously on the display.

798

</dd></dl>

799

800

801

802

<code class="descclassname">window.</code><code class="descname">addstr</code>(str[, attr])<a class="headerlink" href="#curses.window.addstr" title="Permalink to this definition">¶</a></dt>

803

<dt>

804

<code class="descclassname">window.</code><code class="descname">addstr</code>(y, x, str[, attr])</dt>

805

<dd>Paint the string str at <code class="docutils literal">(y, x)</code> with attributes attr, overwriting

806

anything previously on the display.

807

</dd></dl>

808

809

810

811

<code class="descclassname">window.</code><code class="descname">attroff</code>(attr)<a class="headerlink" href="#curses.window.attroff" title="Permalink to this definition">¶</a></dt>

812

<dd>Remove attribute attr from the “background” set applied to all writes to the

813

current window.

814

</dd></dl>

815

816

817

818

<code class="descclassname">window.</code><code class="descname">attron</code>(attr)<a class="headerlink" href="#curses.window.attron" title="Permalink to this definition">¶</a></dt>

819

<dd>Add attribute attr from the “background” set applied to all writes to the

820

current window.

821

</dd></dl>

822

823

824

825

<code class="descclassname">window.</code><code class="descname">attrset</code>(attr)<a class="headerlink" href="#curses.window.attrset" title="Permalink to this definition">¶</a></dt>

826

<dd>Set the “background” set of attributes to attr. This set is initially 0 (no

827

attributes).

828

</dd></dl>

829

830

831

832

<code class="descclassname">window.</code><code class="descname">bkgd</code>(ch[, attr])<a class="headerlink" href="#curses.window.bkgd" title="Permalink to this definition">¶</a></dt>

833

<dd>Set the background property of the window to the character ch, with

834

attributes attr. The change is then applied to every character position in

835

that window:

836

837

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

838

background attribute.</li>

839

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

840

background character.</li>

841

</ul>

842

</dd></dl>

843

844

845

846

<code class="descclassname">window.</code><code class="descname">bkgdset</code>(ch[, attr])<a class="headerlink" href="#curses.window.bkgdset" title="Permalink to this definition">¶</a></dt>

847

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

848

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

849

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

850

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

851

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

852

the character through any scrolling and insert/delete line/character operations.

853

</dd></dl>

854

855

856

857

<code class="descclassname">window.</code><code class="descname">border</code>([ls[, rs[, ts[, bs[, tl[, tr[, bl[, br]]]]]]]])<a class="headerlink" href="#curses.window.border" title="Permalink to this definition">¶</a></dt>

858

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

859

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

860

details. The characters can be specified as integers or as one-character

861

strings.

862

863

Note

864

A <code class="docutils literal">0</code> value for any parameter will cause the default character to be used for

865

that parameter. Keyword parameters can not be used. The defaults are listed

866

in this table:

867

</div>

868

869

870

871

872

873

</colgroup>

874

875

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

876

<th class="head">Description</th>

877

<th class="head">Default value</th>

878

</tr>

879

</thead>

880

881

882

883

<td><code class="xref py py-const docutils literal">ACS_VLINE</code></td>

884

</tr>

885

886

<td>Right side</td>

887

<td><code class="xref py py-const docutils literal">ACS_VLINE</code></td>

888

</tr>

889

890

891

<td><code class="xref py py-const docutils literal">ACS_HLINE</code></td>

892

</tr>

893

894

<td>Bottom</td>

895

<td><code class="xref py py-const docutils literal">ACS_HLINE</code></td>

896

</tr>

897

898

<td>Upper-left corner</td>

899

<td><code class="xref py py-const docutils literal">ACS_ULCORNER</code></td>

900

</tr>

901

902

<td>Upper-right corner</td>

903

<td><code class="xref py py-const docutils literal">ACS_URCORNER</code></td>

904

</tr>

905

906

<td>Bottom-left corner</td>

907

<td><code class="xref py py-const docutils literal">ACS_LLCORNER</code></td>

908

</tr>

909

910

<td>Bottom-right corner</td>

911

<td><code class="xref py py-const docutils literal">ACS_LRCORNER</code></td>

912

</tr>

913

</tbody>

914

</table>

915

</dd></dl>

916

917

918

919

<code class="descclassname">window.</code><code class="descname">box</code>([vertch, horch])<a class="headerlink" href="#curses.window.box" title="Permalink to this definition">¶</a></dt>

920

<dd>Similar to <a class="reference internal" href="#curses.window.border" title="curses.window.border"><code class="xref py py-meth docutils literal">border()</code></a>, but both ls and rs are vertch and both ts and

921

bs are horch. The default corner characters are always used by this function.

922

</dd></dl>

923

924

925

926

<code class="descclassname">window.</code><code class="descname">chgat</code>(attr)<a class="headerlink" href="#curses.window.chgat" title="Permalink to this definition">¶</a></dt>

927

<dt>

928

<code class="descclassname">window.</code><code class="descname">chgat</code>(num, attr)</dt>

929

<dt>

930

<code class="descclassname">window.</code><code class="descname">chgat</code>(y, x, attr)</dt>

931

<dt>

932

<code class="descclassname">window.</code><code class="descname">chgat</code>(y, x, num, attr)</dt>

933

<dd>Set the attributes of num characters at the current cursor position, or at

934

position <code class="docutils literal">(y, x)</code> if supplied. If no value of num is given or num = -1,

935

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

936

function does not move the cursor. The changed line will be touched using the

937

<a class="reference internal" href="#curses.window.touchline" title="curses.window.touchline"><code class="xref py py-meth docutils literal">touchline()</code></a> method so that the contents will be redisplayed by the next

938

window refresh.

939

</dd></dl>

940

941

942

943

<code class="descclassname">window.</code><code class="descname">clear</code>()<a class="headerlink" href="#curses.window.clear" title="Permalink to this definition">¶</a></dt>

944

<dd>Like <a class="reference internal" href="#curses.window.erase" title="curses.window.erase"><code class="xref py py-meth docutils literal">erase()</code></a>, but also cause the whole window to be repainted upon next

945

call to <a class="reference internal" href="#curses.window.refresh" title="curses.window.refresh"><code class="xref py py-meth docutils literal">refresh()</code></a>.

946

</dd></dl>

947

948

949

950

<code class="descclassname">window.</code><code class="descname">clearok</code>(yes)<a class="headerlink" href="#curses.window.clearok" title="Permalink to this definition">¶</a></dt>

951

<dd>If yes is 1, the next call to <a class="reference internal" href="#curses.window.refresh" title="curses.window.refresh"><code class="xref py py-meth docutils literal">refresh()</code></a> will clear the window

952

completely.

953

</dd></dl>

954

955

956

957

<code class="descclassname">window.</code><code class="descname">clrtobot</code>()<a class="headerlink" href="#curses.window.clrtobot" title="Permalink to this definition">¶</a></dt>

958

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

959

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">clrtoeol()</code></a> is performed.

960

</dd></dl>

961

962

963

964

<code class="descclassname">window.</code><code class="descname">clrtoeol</code>()<a class="headerlink" href="#curses.window.clrtoeol" title="Permalink to this definition">¶</a></dt>

965

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

966

</dd></dl>

967

968

969

970

<code class="descclassname">window.</code><code class="descname">cursyncup</code>()<a class="headerlink" href="#curses.window.cursyncup" title="Permalink to this definition">¶</a></dt>

971

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

972

reflect the current cursor position of the window.

973

</dd></dl>

974

975

976

977

<code class="descclassname">window.</code><code class="descname">delch</code>([y, x])<a class="headerlink" href="#curses.window.delch" title="Permalink to this definition">¶</a></dt>

978

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

979

</dd></dl>

980

981

982

983

<code class="descclassname">window.</code><code class="descname">deleteln</code>()<a class="headerlink" href="#curses.window.deleteln" title="Permalink to this definition">¶</a></dt>

984

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

985

</dd></dl>

986

987

988

989

<code class="descclassname">window.</code><code class="descname">derwin</code>(begin_y, begin_x)<a class="headerlink" href="#curses.window.derwin" title="Permalink to this definition">¶</a></dt>

990

<dt>

991

<code class="descclassname">window.</code><code class="descname">derwin</code>(nlines, ncols, begin_y, begin_x)</dt>

992

<dd>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">derwin()</code></a> is the same as calling

993

<a class="reference internal" href="#curses.window.subwin" title="curses.window.subwin"><code class="xref py py-meth docutils literal">subwin()</code></a>, except that begin_y and begin_x are relative to the origin

994

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

995

object for the derived window.

996

</dd></dl>

997

998

999

1000

<code class="descclassname">window.</code><code class="descname">echochar</code>(ch[, attr])<a class="headerlink" href="#curses.window.echochar" title="Permalink to this definition">¶</a></dt>

1001

<dd>Add character ch with attribute attr, and immediately call <a class="reference internal" href="#curses.window.refresh" title="curses.window.refresh"><code class="xref py py-meth docutils literal">refresh()</code></a>

1002

on the window.

1003

</dd></dl>

1004

1005

1006

1007

<code class="descclassname">window.</code><code class="descname">enclose</code>(y, x)<a class="headerlink" href="#curses.window.enclose" title="Permalink to this definition">¶</a></dt>

1008

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

1009

enclosed by the given window, returning <code class="docutils literal">True</code> or <code class="docutils literal">False</code>. It is useful for

1010

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

1011

event.

1012

</dd></dl>

1013

1014

1015

1016

<code class="descclassname">window.</code><code class="descname">erase</code>()<a class="headerlink" href="#curses.window.erase" title="Permalink to this definition">¶</a></dt>

1017

<dd>Clear the window.

1018

</dd></dl>

1019

1020

1021

1022

<code class="descclassname">window.</code><code class="descname">getbegyx</code>()<a class="headerlink" href="#curses.window.getbegyx" title="Permalink to this definition">¶</a></dt>

1023

<dd>Return a tuple <code class="docutils literal">(y, x)</code> of co-ordinates of upper-left corner.

1024

</dd></dl>

1025

1026

1027

1028

<code class="descclassname">window.</code><code class="descname">getbkgd</code>()<a class="headerlink" href="#curses.window.getbkgd" title="Permalink to this definition">¶</a></dt>

1029

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

1030

</dd></dl>

1031

1032

1033

1034

<code class="descclassname">window.</code><code class="descname">getch</code>([y, x])<a class="headerlink" href="#curses.window.getch" title="Permalink to this definition">¶</a></dt>

1035

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

1036

range: function keys, keypad keys and so on return numbers higher than 256. In

1037

no-delay mode, -1 is returned if there is no input, else <a class="reference internal" href="#curses.window.getch" title="curses.window.getch"><code class="xref py py-func docutils literal">getch()</code></a> waits

1038

until a key is pressed.

1039

</dd></dl>

1040

1041

1042

1043

<code class="descclassname">window.</code><code class="descname">getkey</code>([y, x])<a class="headerlink" href="#curses.window.getkey" title="Permalink to this definition">¶</a></dt>

1044

<dd>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">getch()</code></a>

1045

does. Function keys, keypad keys and so on return a multibyte string containing

1046

the key name. In no-delay mode, an exception is raised if there is no input.

1047

</dd></dl>

1048

1049

1050

1051

<code class="descclassname">window.</code><code class="descname">getmaxyx</code>()<a class="headerlink" href="#curses.window.getmaxyx" title="Permalink to this definition">¶</a></dt>

1052

<dd>Return a tuple <code class="docutils literal">(y, x)</code> of the height and width of the window.

1053

</dd></dl>

1054

1055

1056

1057

<code class="descclassname">window.</code><code class="descname">getparyx</code>()<a class="headerlink" href="#curses.window.getparyx" title="Permalink to this definition">¶</a></dt>

1058

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

1059

into two integer variables y and x. Return <code class="docutils literal">-1, -1</code> if this window has no

1060

parent.

1061

</dd></dl>

1062

1063

1064

1065

<code class="descclassname">window.</code><code class="descname">getstr</code>([y, x])<a class="headerlink" href="#curses.window.getstr" title="Permalink to this definition">¶</a></dt>

1066

<dd>Read a string from the user, with primitive line editing capacity.

1067

</dd></dl>

1068

1069

1070

1071

<code class="descclassname">window.</code><code class="descname">getyx</code>()<a class="headerlink" href="#curses.window.getyx" title="Permalink to this definition">¶</a></dt>

1072

<dd>Return a tuple <code class="docutils literal">(y, x)</code> of current cursor position relative to the window’s

1073

upper-left corner.

1074

</dd></dl>

1075

1076

1077

1078

<code class="descclassname">window.</code><code class="descname">hline</code>(ch, n)<a class="headerlink" href="#curses.window.hline" title="Permalink to this definition">¶</a></dt>

1079

<dt>

1080

<code class="descclassname">window.</code><code class="descname">hline</code>(y, x, ch, n)</dt>

1081

<dd>Display a horizontal line starting at <code class="docutils literal">(y, x)</code> with length n consisting of

1082

the character ch.

1083

</dd></dl>

1084

1085

1086

1087

<code class="descclassname">window.</code><code class="descname">idcok</code>(flag)<a class="headerlink" href="#curses.window.idcok" title="Permalink to this definition">¶</a></dt>

1088

<dd>If flag is <code class="docutils literal">False</code>, curses no longer considers using the hardware insert/delete

1089

character feature of the terminal; if flag is <code class="docutils literal">True</code>, use of character insertion

1090

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

1091

insert/delete is enabled by default.

1092

</dd></dl>

1093

1094

1095

1096

<code class="descclassname">window.</code><code class="descname">idlok</code>(yes)<a class="headerlink" href="#curses.window.idlok" title="Permalink to this definition">¶</a></dt>

1097

<dd>If called with yes equal to 1, <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">curses</code></a> will try and use hardware line

1098

editing facilities. Otherwise, line insertion/deletion are disabled.

1099

</dd></dl>

1100

1101

1102

1103

<code class="descclassname">window.</code><code class="descname">immedok</code>(flag)<a class="headerlink" href="#curses.window.immedok" title="Permalink to this definition">¶</a></dt>

1104

<dd>If flag is <code class="docutils literal">True</code>, any change in the window image automatically causes the

1105

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">refresh()</code></a> yourself.

1106

However, it may degrade performance considerably, due to repeated calls to

1107

wrefresh. This option is disabled by default.

1108

</dd></dl>

1109

1110

1111

1112

<code class="descclassname">window.</code><code class="descname">inch</code>([y, x])<a class="headerlink" href="#curses.window.inch" title="Permalink to this definition">¶</a></dt>

1113

<dd>Return the character at the given position in the window. The bottom 8 bits are

1114

the character proper, and upper bits are the attributes.

1115

</dd></dl>

1116

1117

1118

1119

<code class="descclassname">window.</code><code class="descname">insch</code>(ch[, attr])<a class="headerlink" href="#curses.window.insch" title="Permalink to this definition">¶</a></dt>

1120

<dt>

1121

<code class="descclassname">window.</code><code class="descname">insch</code>(y, x, ch[, attr])</dt>

1122

<dd>Paint character ch at <code class="docutils literal">(y, x)</code> with attributes attr, moving the line from

1123

position x right by one character.

1124

</dd></dl>

1125

1126

1127

1128

<code class="descclassname">window.</code><code class="descname">insdelln</code>(nlines)<a class="headerlink" href="#curses.window.insdelln" title="Permalink to this definition">¶</a></dt>

1129

<dd>Insert nlines lines into the specified window above the current line. The

1130

nlines bottom lines are lost. For negative nlines, delete nlines lines

1131

starting with the one under the cursor, and move the remaining lines up. The

1132

bottom nlines lines are cleared. The current cursor position remains the

1133

same.

1134

</dd></dl>

1135

1136

1137

1138

<code class="descclassname">window.</code><code class="descname">insertln</code>()<a class="headerlink" href="#curses.window.insertln" title="Permalink to this definition">¶</a></dt>

1139

<dd>Insert a blank line under the cursor. All following lines are moved down by one

1140

line.

1141

</dd></dl>

1142

1143

1144

1145

<code class="descclassname">window.</code><code class="descname">insnstr</code>(str, n[, attr])<a class="headerlink" href="#curses.window.insnstr" title="Permalink to this definition">¶</a></dt>

1146

<dt>

1147

<code class="descclassname">window.</code><code class="descname">insnstr</code>(y, x, str, n[, attr])</dt>

1148

<dd>Insert a character string (as many characters as will fit on the line) before

1149

the character under the cursor, up to n characters. If n is zero or

1150

negative, the entire string is inserted. All characters to the right of the

1151

cursor are shifted right, with the rightmost characters on the line being lost.

1152

The cursor position does not change (after moving to y, x, if specified).

1153

</dd></dl>

1154

1155

1156

1157

<code class="descclassname">window.</code><code class="descname">insstr</code>(str[, attr])<a class="headerlink" href="#curses.window.insstr" title="Permalink to this definition">¶</a></dt>

1158

<dt>

1159

<code class="descclassname">window.</code><code class="descname">insstr</code>(y, x, str[, attr])</dt>

1160

<dd>Insert a character string (as many characters as will fit on the line) before

1161

the character under the cursor. All characters to the right of the cursor are

1162

shifted right, with the rightmost characters on the line being lost. The cursor

1163

position does not change (after moving to y, x, if specified).

1164

</dd></dl>

1165

1166

1167

1168

<code class="descclassname">window.</code><code class="descname">instr</code>([n])<a class="headerlink" href="#curses.window.instr" title="Permalink to this definition">¶</a></dt>

1169

<dt>

1170

<code class="descclassname">window.</code><code class="descname">instr</code>(y, x[, n])</dt>

1171

<dd>Return a string of characters, extracted from the window starting at the

1172

current cursor position, or at y, x if specified. Attributes are stripped

1173

from the characters. If n is specified, <a class="reference internal" href="#curses.window.instr" title="curses.window.instr"><code class="xref py py-meth docutils literal">instr()</code></a> returns a string

1174

at most n characters long (exclusive of the trailing NUL).

1175

</dd></dl>

1176

1177

1178

1179

<code class="descclassname">window.</code><code class="descname">is_linetouched</code>(line)<a class="headerlink" href="#curses.window.is_linetouched" title="Permalink to this definition">¶</a></dt>

1180

<dd>Return <code class="docutils literal">True</code> if the specified line was modified since the last call to

1181

<a class="reference internal" href="#curses.window.refresh" title="curses.window.refresh"><code class="xref py py-meth docutils literal">refresh()</code></a>; otherwise return <code class="docutils literal">False</code>. Raise a <a class="reference internal" href="#curses.error" title="curses.error"><code class="xref py py-exc docutils literal">curses.error</code></a>

1182

exception if line is not valid for the given window.

1183

</dd></dl>

1184

1185

1186

1187

<code class="descclassname">window.</code><code class="descname">is_wintouched</code>()<a class="headerlink" href="#curses.window.is_wintouched" title="Permalink to this definition">¶</a></dt>

1188

<dd>Return <code class="docutils literal">True</code> if the specified window was modified since the last call to

1189

1190

</dd></dl>

1191

1192

1193

1194

<code class="descclassname">window.</code><code class="descname">keypad</code>(yes)<a class="headerlink" href="#curses.window.keypad" title="Permalink to this definition">¶</a></dt>

1195

<dd>If yes is 1, escape sequences generated by some keys (keypad, function keys)

1196

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">curses</code></a>. If yes is 0, escape sequences will be

1197

left as is in the input stream.

1198

</dd></dl>

1199

1200

1201

1202

<code class="descclassname">window.</code><code class="descname">leaveok</code>(yes)<a class="headerlink" href="#curses.window.leaveok" title="Permalink to this definition">¶</a></dt>

1203

<dd>If yes is 1, cursor is left where it is on update, instead of being at “cursor

1204

position.” This reduces cursor movement where possible. If possible the cursor

1205

will be made invisible.

1206

If yes is 0, cursor will always be at “cursor position” after an update.

1207

</dd></dl>

1208

1209

1210

1211

<code class="descclassname">window.</code><code class="descname">move</code>(new_y, new_x)<a class="headerlink" href="#curses.window.move" title="Permalink to this definition">¶</a></dt>

1212

<dd>Move cursor to <code class="docutils literal">(new_y, new_x)</code>.

1213

</dd></dl>

1214

1215

1216

1217

<code class="descclassname">window.</code><code class="descname">mvderwin</code>(y, x)<a class="headerlink" href="#curses.window.mvderwin" title="Permalink to this definition">¶</a></dt>

1218

<dd>Move the window inside its parent window. The screen-relative parameters of

1219

the window are not changed. This routine is used to display different parts of

1220

the parent window at the same physical position on the screen.

1221

</dd></dl>

1222

1223

1224

1225

<code class="descclassname">window.</code><code class="descname">mvwin</code>(new_y, new_x)<a class="headerlink" href="#curses.window.mvwin" title="Permalink to this definition">¶</a></dt>

1226

<dd>Move the window so its upper-left corner is at <code class="docutils literal">(new_y, new_x)</code>.

1227

</dd></dl>

1228

1229

1230

1231

<code class="descclassname">window.</code><code class="descname">nodelay</code>(yes)<a class="headerlink" href="#curses.window.nodelay" title="Permalink to this definition">¶</a></dt>

1232

<dd>If yes is <code class="docutils literal">1</code>, <a class="reference internal" href="#curses.window.getch" title="curses.window.getch"><code class="xref py py-meth docutils literal">getch()</code></a> will be non-blocking.

1233

</dd></dl>

1234

1235

1236

1237

<code class="descclassname">window.</code><code class="descname">notimeout</code>(yes)<a class="headerlink" href="#curses.window.notimeout" title="Permalink to this definition">¶</a></dt>

1238

<dd>If yes is <code class="docutils literal">1</code>, escape sequences will not be timed out.

1239

If yes is <code class="docutils literal">0</code>, after a few milliseconds, an escape sequence will not be

1240

interpreted, and will be left in the input stream as is.

1241

</dd></dl>

1242

1243

1244

1245

<code class="descclassname">window.</code><code class="descname">noutrefresh</code>()<a class="headerlink" href="#curses.window.noutrefresh" title="Permalink to this definition">¶</a></dt>

1246

<dd>Mark for refresh but wait. This function updates the data structure

1247

representing the desired state of the window, but does not force an update of

1248

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">doupdate()</code></a>.

1249

</dd></dl>

1250

1251

1252

1253

<code class="descclassname">window.</code><code class="descname">overlay</code>(destwin[, sminrow, smincol, dminrow, dmincol, dmaxrow, dmaxcol])<a class="headerlink" href="#curses.window.overlay" title="Permalink to this definition">¶</a></dt>

1254

<dd>Overlay the window on top of destwin. The windows need not be the same size,

1255

only the overlapping region is copied. This copy is non-destructive, which means

1256

that the current background character does not overwrite the old contents of

1257

destwin.

1258

To get fine-grained control over the copied region, the second form of

1259

<a class="reference internal" href="#curses.window.overlay" title="curses.window.overlay"><code class="xref py py-meth docutils literal">overlay()</code></a> can be used. sminrow and smincol are the upper-left

1260

coordinates of the source window, and the other variables mark a rectangle in

1261

the destination window.

1262

</dd></dl>

1263

1264

1265

1266

<code class="descclassname">window.</code><code class="descname">overwrite</code>(destwin[, sminrow, smincol, dminrow, dmincol, dmaxrow, dmaxcol])<a class="headerlink" href="#curses.window.overwrite" title="Permalink to this definition">¶</a></dt>

1267

<dd>Overwrite the window on top of destwin. The windows need not be the same size,

1268

in which case only the overlapping region is copied. This copy is destructive,

1269

which means that the current background character overwrites the old contents of

1270

destwin.

1271

To get fine-grained control over the copied region, the second form of

1272

<a class="reference internal" href="#curses.window.overwrite" title="curses.window.overwrite"><code class="xref py py-meth docutils literal">overwrite()</code></a> can be used. sminrow and smincol are the upper-left

1273

coordinates of the source window, the other variables mark a rectangle in the

1274

destination window.

1275

</dd></dl>

1276

1277

1278

1279

<code class="descclassname">window.</code><code class="descname">putwin</code>(file)<a class="headerlink" href="#curses.window.putwin" title="Permalink to this definition">¶</a></dt>

1280

<dd>Write all data associated with the window into the provided file object. This

1281

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">getwin()</code></a> function.

1282

</dd></dl>

1283

1284

1285

1286

<code class="descclassname">window.</code><code class="descname">redrawln</code>(beg, num)<a class="headerlink" href="#curses.window.redrawln" title="Permalink to this definition">¶</a></dt>

1287

<dd>Indicate that the num screen lines, starting at line beg, are corrupted and

1288

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">refresh()</code></a> call.

1289

</dd></dl>

1290

1291

1292

1293

<code class="descclassname">window.</code><code class="descname">redrawwin</code>()<a class="headerlink" href="#curses.window.redrawwin" title="Permalink to this definition">¶</a></dt>

1294

<dd>Touch the entire window, causing it to be completely redrawn on the next

1295

<a class="reference internal" href="#curses.window.refresh" title="curses.window.refresh"><code class="xref py py-meth docutils literal">refresh()</code></a> call.

1296

</dd></dl>

1297

1298

1299

1300

<code class="descclassname">window.</code><code class="descname">refresh</code>([pminrow, pmincol, sminrow, smincol, smaxrow, smaxcol])<a class="headerlink" href="#curses.window.refresh" title="Permalink to this definition">¶</a></dt>

1301

<dd>Update the display immediately (sync actual screen with previous

1302

drawing/deleting methods).

1303

The 6 optional arguments can only be specified when the window is a pad created

1304

with <a class="reference internal" href="#curses.newpad" title="curses.newpad"><code class="xref py py-func docutils literal">newpad()</code></a>. The additional parameters are needed to indicate what part

1305

of the pad and screen are involved. pminrow and pmincol specify the upper

1306

left-hand corner of the rectangle to be displayed in the pad. sminrow,

1307

smincol, smaxrow, and smaxcol specify the edges of the rectangle to be

1308

displayed on the screen. The lower right-hand corner of the rectangle to be

1309

displayed in the pad is calculated from the screen coordinates, since the

1310

rectangles must be the same size. Both rectangles must be entirely contained

1311

within their respective structures. Negative values of pminrow, pmincol,

1312

sminrow, or smincol are treated as if they were zero.

1313

</dd></dl>

1314

1315

1316

1317

<code class="descclassname">window.</code><code class="descname">resize</code>(nlines, ncols)<a class="headerlink" href="#curses.window.resize" title="Permalink to this definition">¶</a></dt>

1318

<dd>Reallocate storage for a curses window to adjust its dimensions to the

1319

specified values. If either dimension is larger than the current values, the

1320

window’s data is filled with blanks that have the current background

1321

rendition (as set by <a class="reference internal" href="#curses.window.bkgdset" title="curses.window.bkgdset"><code class="xref py py-meth docutils literal">bkgdset()</code></a>) merged into them.

1322

</dd></dl>

1323

1324

1325

1326

<code class="descclassname">window.</code><code class="descname">scroll</code>([lines=1])<a class="headerlink" href="#curses.window.scroll" title="Permalink to this definition">¶</a></dt>

1327

<dd>Scroll the screen or scrolling region upward by lines lines.

1328

</dd></dl>

1329

1330

1331

1332

<code class="descclassname">window.</code><code class="descname">scrollok</code>(flag)<a class="headerlink" href="#curses.window.scrollok" title="Permalink to this definition">¶</a></dt>

1333

<dd>Control what happens when the cursor of a window is moved off the edge of the

1334

window or scrolling region, either as a result of a newline action on the bottom

1335

line, or typing the last character of the last line. If flag is false, the

1336

cursor is left on the bottom line. If flag is true, the window is scrolled up

1337

one line. Note that in order to get the physical scrolling effect on the

1338

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">idlok()</code></a>.

1339

</dd></dl>

1340

1341

1342

1343

<code class="descclassname">window.</code><code class="descname">setscrreg</code>(top, bottom)<a class="headerlink" href="#curses.window.setscrreg" title="Permalink to this definition">¶</a></dt>

1344

<dd>Set the scrolling region from line top to line bottom. All scrolling actions

1345

will take place in this region.

1346

</dd></dl>

1347

1348

1349

1350

<code class="descclassname">window.</code><code class="descname">standend</code>()<a class="headerlink" href="#curses.window.standend" title="Permalink to this definition">¶</a></dt>

1351

<dd>Turn off the standout attribute. On some terminals this has the side effect of

1352

turning off all attributes.

1353

</dd></dl>

1354

1355

1356

1357

<code class="descclassname">window.</code><code class="descname">standout</code>()<a class="headerlink" href="#curses.window.standout" title="Permalink to this definition">¶</a></dt>

1358

<dd>Turn on attribute A_STANDOUT.

1359

</dd></dl>

1360

1361

1362

1363

<code class="descclassname">window.</code><code class="descname">subpad</code>(begin_y, begin_x)<a class="headerlink" href="#curses.window.subpad" title="Permalink to this definition">¶</a></dt>

1364

<dt>

1365

<code class="descclassname">window.</code><code class="descname">subpad</code>(nlines, ncols, begin_y, begin_x)</dt>

1366

<dd>Return a sub-window, whose upper-left corner is at <code class="docutils literal">(begin_y, begin_x)</code>, and

1367

whose width/height is ncols/nlines.

1368

</dd></dl>

1369

1370

1371

1372

<code class="descclassname">window.</code><code class="descname">subwin</code>(begin_y, begin_x)<a class="headerlink" href="#curses.window.subwin" title="Permalink to this definition">¶</a></dt>

1373

<dt>

1374

<code class="descclassname">window.</code><code class="descname">subwin</code>(nlines, ncols, begin_y, begin_x)</dt>

1375

<dd>Return a sub-window, whose upper-left corner is at <code class="docutils literal">(begin_y, begin_x)</code>, and

1376

whose width/height is ncols/nlines.

1377

By default, the sub-window will extend from the specified position to the lower

1378

right corner of the window.

1379

</dd></dl>

1380

1381

1382

1383

<code class="descclassname">window.</code><code class="descname">syncdown</code>()<a class="headerlink" href="#curses.window.syncdown" title="Permalink to this definition">¶</a></dt>

1384

<dd>Touch each location in the window that has been touched in any of its ancestor

1385

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">refresh()</code></a>, so it should almost never

1386

be necessary to call it manually.

1387

</dd></dl>

1388

1389

1390

1391

<code class="descclassname">window.</code><code class="descname">syncok</code>(flag)<a class="headerlink" href="#curses.window.syncok" title="Permalink to this definition">¶</a></dt>

1392

<dd>If called with flag set to <code class="docutils literal">True</code>, then <a class="reference internal" href="#curses.window.syncup" title="curses.window.syncup"><code class="xref py py-meth docutils literal">syncup()</code></a> is called automatically

1393

whenever there is a change in the window.

1394

</dd></dl>

1395

1396

1397

1398

<code class="descclassname">window.</code><code class="descname">syncup</code>()<a class="headerlink" href="#curses.window.syncup" title="Permalink to this definition">¶</a></dt>

1399

<dd>Touch all locations in ancestors of the window that have been changed in the

1400

window.

1401

</dd></dl>

1402

1403

1404

1405

<code class="descclassname">window.</code><code class="descname">timeout</code>(delay)<a class="headerlink" href="#curses.window.timeout" title="Permalink to this definition">¶</a></dt>

1406

<dd>Set blocking or non-blocking read behavior for the window. If delay is

1407

negative, blocking read is used (which will wait indefinitely for input). If

1408

delay is zero, then non-blocking read is used, and -1 will be returned by

1409

<a class="reference internal" href="#curses.window.getch" title="curses.window.getch"><code class="xref py py-meth docutils literal">getch()</code></a> if no input is waiting. If delay is positive, then

1410

<a class="reference internal" href="#curses.window.getch" title="curses.window.getch"><code class="xref py py-meth docutils literal">getch()</code></a> will block for delay milliseconds, and return -1 if there is

1411

still no input at the end of that time.

1412

</dd></dl>

1413

1414

1415

1416

<code class="descclassname">window.</code><code class="descname">touchline</code>(start, count[, changed])<a class="headerlink" href="#curses.window.touchline" title="Permalink to this definition">¶</a></dt>

1417

<dd>Pretend count lines have been changed, starting with line start. If

1418

changed is supplied, it specifies whether the affected lines are marked as

1419

having been changed (changed=1) or unchanged (changed=0).

1420

</dd></dl>

1421

1422

1423

1424

<code class="descclassname">window.</code><code class="descname">touchwin</code>()<a class="headerlink" href="#curses.window.touchwin" title="Permalink to this definition">¶</a></dt>

1425

<dd>Pretend the whole window has been changed, for purposes of drawing

1426

optimizations.

1427

</dd></dl>

1428

1429

1430

1431

<code class="descclassname">window.</code><code class="descname">untouchwin</code>()<a class="headerlink" href="#curses.window.untouchwin" title="Permalink to this definition">¶</a></dt>

1432

<dd>Mark all lines in the window as unchanged since the last call to

1433

<a class="reference internal" href="#curses.window.refresh" title="curses.window.refresh"><code class="xref py py-meth docutils literal">refresh()</code></a>.

1434

</dd></dl>

1435

1436

1437

1438

<code class="descclassname">window.</code><code class="descname">vline</code>(ch, n)<a class="headerlink" href="#curses.window.vline" title="Permalink to this definition">¶</a></dt>

1439

<dt>

1440

<code class="descclassname">window.</code><code class="descname">vline</code>(y, x, ch, n)</dt>

1441

<dd>Display a vertical line starting at <code class="docutils literal">(y, x)</code> with length n consisting of the

1442

character ch.

1443

</dd></dl>

1444

1445

</div>

1446

1447

<h2>15.11.3. Constants<a class="headerlink" href="#constants" title="Permalink to this headline">¶</a></h2>

1448

1449

1450

1451

<code class="descclassname">curses.</code><code class="descname">ERR</code><a class="headerlink" href="#curses.ERR" title="Permalink to this definition">¶</a></dt>

1452

<dd>Some curses routines that return an integer, such as <code class="xref py py-func docutils literal">getch()</code>, return

1453

<a class="reference internal" href="#curses.ERR" title="curses.ERR"><code class="xref py py-const docutils literal">ERR</code></a> upon failure.

1454

</dd></dl>

1455

1456

1457

1458

<code class="descclassname">curses.</code><code class="descname">OK</code><a class="headerlink" href="#curses.OK" title="Permalink to this definition">¶</a></dt>

1459

<dd>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">napms()</code></a>, return

1460

<a class="reference internal" href="#curses.OK" title="curses.OK"><code class="xref py py-const docutils literal">OK</code></a> upon success.

1461

</dd></dl>

1462

1463

1464

1465

<code class="descclassname">curses.</code><code class="descname">version</code><a class="headerlink" href="#curses.version" title="Permalink to this definition">¶</a></dt>

1466

<dd>A string representing the current version of the module. Also available as

1467

<code class="xref py py-const docutils literal">__version__</code>.

1468

</dd></dl>

1469

1470

Several constants are available to specify character cell attributes:

1471

1472

1473

1474

1475

</colgroup>

1476

1477

<tr class="row-odd"><th class="head">Attribute</th>

1478

<th class="head">Meaning</th>

1479

</tr>

1480

</thead>

1481

1482

<tr class="row-even"><td><code class="docutils literal">A_ALTCHARSET</code></td>

1483

<td>Alternate character set mode.</td>

1484

</tr>

1485

<tr class="row-odd"><td><code class="docutils literal">A_BLINK</code></td>

1486

<td>Blink mode.</td>

1487

</tr>

1488

1489

1490

</tr>

1491

1492

1493

</tr>

1494

<tr class="row-even"><td><code class="docutils literal">A_NORMAL</code></td>

1495

<td>Normal attribute.</td>

1496

</tr>

1497

<tr class="row-odd"><td><code class="docutils literal">A_REVERSE</code></td>

1498

<td>Reverse background and

1499

foreground colors.</td>

1500

</tr>

1501

<tr class="row-even"><td><code class="docutils literal">A_STANDOUT</code></td>

1502

<td>Standout mode.</td>

1503

</tr>

1504

<tr class="row-odd"><td><code class="docutils literal">A_UNDERLINE</code></td>

1505

<td>Underline mode.</td>

1506

</tr>

1507

</tbody>

1508

</table>

1509

Keys are referred to by integer constants with names starting with <code class="docutils literal">KEY_</code>.

1510

The exact keycaps available are system dependent.

1511

1512

1513

1514

1515

</colgroup>

1516

1517

<tr class="row-odd"><th class="head">Key constant</th>

1518

1519

</tr>

1520

</thead>

1521

1522

1523

<td>Minimum key value</td>

1524

</tr>

1525

<tr class="row-odd"><td><code class="docutils literal">KEY_BREAK</code></td>

1526

<td>Break key (unreliable)</td>

1527

</tr>

1528

1529

<td>Down-arrow</td>

1530

</tr>

1531

1532

<td>Up-arrow</td>

1533

</tr>

1534

1535

<td>Left-arrow</td>

1536

</tr>

1537

<tr class="row-odd"><td><code class="docutils literal">KEY_RIGHT</code></td>

1538

<td>Right-arrow</td>

1539

</tr>

1540

1541

<td>Home key (upward+left arrow)</td>

1542

</tr>

1543

<tr class="row-odd"><td><code class="docutils literal">KEY_BACKSPACE</code></td>

1544

<td>Backspace (unreliable)</td>

1545

</tr>

1546

1547

<td>Function keys. Up to 64 function keys are

1548

supported.</td>

1549

</tr>

1550

1551

<td>Value of function key n</td>

1552

</tr>

1553

1554

<td>Delete line</td>

1555

</tr>

1556

1557

<td>Insert line</td>

1558

</tr>

1559

1560

<td>Delete character</td>

1561

</tr>

1562

1563

<td>Insert char or enter insert mode</td>

1564

</tr>

1565

1566

<td>Exit insert char mode</td>

1567

</tr>

1568

<tr class="row-odd"><td><code class="docutils literal">KEY_CLEAR</code></td>

1569

<td>Clear screen</td>

1570

</tr>

1571

1572

<td>Clear to end of screen</td>

1573

</tr>

1574

1575

<td>Clear to end of line</td>

1576

</tr>

1577

1578

<td>Scroll 1 line forward</td>

1579

</tr>

1580

1581

<td>Scroll 1 line backward (reverse)</td>

1582

</tr>

1583

<tr class="row-even"><td><code class="docutils literal">KEY_NPAGE</code></td>

1584

1585

</tr>

1586

<tr class="row-odd"><td><code class="docutils literal">KEY_PPAGE</code></td>

1587

<td>Previous page</td>

1588

</tr>

1589

1590

1591

</tr>

1592

1593

<td>Clear tab</td>

1594

</tr>

1595

<tr class="row-even"><td><code class="docutils literal">KEY_CATAB</code></td>

1596

<td>Clear all tabs</td>

1597

</tr>

1598

<tr class="row-odd"><td><code class="docutils literal">KEY_ENTER</code></td>

1599

<td>Enter or send (unreliable)</td>

1600

</tr>

1601

<tr class="row-even"><td><code class="docutils literal">KEY_SRESET</code></td>

1602

<td>Soft (partial) reset (unreliable)</td>

1603

</tr>

1604

<tr class="row-odd"><td><code class="docutils literal">KEY_RESET</code></td>

1605

<td>Reset or hard reset (unreliable)</td>

1606

</tr>

1607

<tr class="row-even"><td><code class="docutils literal">KEY_PRINT</code></td>

1608

<td>Print</td>

1609

</tr>

1610

1611

<td>Home down or bottom (lower left)</td>

1612

</tr>

1613

1614

<td>Upper left of keypad</td>

1615

</tr>

1616

1617

<td>Upper right of keypad</td>

1618

</tr>

1619

1620

<td>Center of keypad</td>

1621

</tr>

1622

1623

<td>Lower left of keypad</td>

1624

</tr>

1625

1626

<td>Lower right of keypad</td>

1627

</tr>

1628

1629

1630

</tr>

1631

1632

<td>Beg (beginning)</td>

1633

</tr>

1634

<tr class="row-odd"><td><code class="docutils literal">KEY_CANCEL</code></td>

1635

<td>Cancel</td>

1636

</tr>

1637

<tr class="row-even"><td><code class="docutils literal">KEY_CLOSE</code></td>

1638

<td>Close</td>

1639

</tr>

1640

<tr class="row-odd"><td><code class="docutils literal">KEY_COMMAND</code></td>

1641

<td>Cmd (command)</td>

1642

</tr>

1643

1644

1645

</tr>

1646

<tr class="row-odd"><td><code class="docutils literal">KEY_CREATE</code></td>

1647

<td>Create</td>

1648

</tr>

1649

1650

1651

</tr>

1652

1653

1654

</tr>

1655

1656

1657

</tr>

1658

1659

1660

</tr>

1661

1662

1663

</tr>

1664

<tr class="row-odd"><td><code class="docutils literal">KEY_MESSAGE</code></td>

1665

<td>Message</td>

1666

</tr>

1667

1668

1669

</tr>

1670

1671

1672

</tr>

1673

1674

1675

</tr>

1676

<tr class="row-odd"><td><code class="docutils literal">KEY_OPTIONS</code></td>

1677

<td>Options</td>

1678

</tr>

1679

<tr class="row-even"><td><code class="docutils literal">KEY_PREVIOUS</code></td>

1680

<td>Prev (previous)</td>

1681

</tr>

1682

1683

1684

</tr>

1685

<tr class="row-even"><td><code class="docutils literal">KEY_REFERENCE</code></td>

1686

<td>Ref (reference)</td>

1687

</tr>

1688

<tr class="row-odd"><td><code class="docutils literal">KEY_REFRESH</code></td>

1689

<td>Refresh</td>

1690

</tr>

1691

<tr class="row-even"><td><code class="docutils literal">KEY_REPLACE</code></td>

1692

<td>Replace</td>

1693

</tr>

1694

<tr class="row-odd"><td><code class="docutils literal">KEY_RESTART</code></td>

1695

<td>Restart</td>

1696

</tr>

1697

<tr class="row-even"><td><code class="docutils literal">KEY_RESUME</code></td>

1698

<td>Resume</td>

1699

</tr>

1700

1701

1702

</tr>

1703

1704

<td>Shifted Beg (beginning)</td>

1705

</tr>

1706

<tr class="row-odd"><td><code class="docutils literal">KEY_SCANCEL</code></td>

1707

<td>Shifted Cancel</td>

1708

</tr>

1709

<tr class="row-even"><td><code class="docutils literal">KEY_SCOMMAND</code></td>

1710

<td>Shifted Command</td>

1711

</tr>

1712

<tr class="row-odd"><td><code class="docutils literal">KEY_SCOPY</code></td>

1713

<td>Shifted Copy</td>

1714

</tr>

1715

<tr class="row-even"><td><code class="docutils literal">KEY_SCREATE</code></td>

1716

<td>Shifted Create</td>

1717

</tr>

1718

1719

<td>Shifted Delete char</td>

1720

</tr>

1721

1722

<td>Shifted Delete line</td>

1723

</tr>

1724

<tr class="row-odd"><td><code class="docutils literal">KEY_SELECT</code></td>

1725

<td>Select</td>

1726

</tr>

1727

1728

<td>Shifted End</td>

1729

</tr>

1730

1731

<td>Shifted Clear line</td>

1732

</tr>

1733

<tr class="row-even"><td><code class="docutils literal">KEY_SEXIT</code></td>

1734

<td>Shifted Dxit</td>

1735

</tr>

1736

<tr class="row-odd"><td><code class="docutils literal">KEY_SFIND</code></td>

1737

<td>Shifted Find</td>

1738

</tr>

1739

<tr class="row-even"><td><code class="docutils literal">KEY_SHELP</code></td>

1740

<td>Shifted Help</td>

1741

</tr>

1742

<tr class="row-odd"><td><code class="docutils literal">KEY_SHOME</code></td>

1743

<td>Shifted Home</td>

1744

</tr>

1745

1746

<td>Shifted Input</td>

1747

</tr>

1748

<tr class="row-odd"><td><code class="docutils literal">KEY_SLEFT</code></td>

1749

<td>Shifted Left arrow</td>

1750

</tr>

1751

<tr class="row-even"><td><code class="docutils literal">KEY_SMESSAGE</code></td>

1752

<td>Shifted Message</td>

1753

</tr>

1754

<tr class="row-odd"><td><code class="docutils literal">KEY_SMOVE</code></td>

1755

<td>Shifted Move</td>

1756

</tr>

1757

<tr class="row-even"><td><code class="docutils literal">KEY_SNEXT</code></td>

1758

<td>Shifted Next</td>

1759

</tr>

1760

<tr class="row-odd"><td><code class="docutils literal">KEY_SOPTIONS</code></td>

1761

<td>Shifted Options</td>

1762

</tr>

1763

<tr class="row-even"><td><code class="docutils literal">KEY_SPREVIOUS</code></td>

1764

<td>Shifted Prev</td>

1765

</tr>

1766

<tr class="row-odd"><td><code class="docutils literal">KEY_SPRINT</code></td>

1767

<td>Shifted Print</td>

1768

</tr>

1769

<tr class="row-even"><td><code class="docutils literal">KEY_SREDO</code></td>

1770

<td>Shifted Redo</td>

1771

</tr>

1772

<tr class="row-odd"><td><code class="docutils literal">KEY_SREPLACE</code></td>

1773

<td>Shifted Replace</td>

1774

</tr>

1775

<tr class="row-even"><td><code class="docutils literal">KEY_SRIGHT</code></td>

1776

<td>Shifted Right arrow</td>

1777

</tr>

1778

<tr class="row-odd"><td><code class="docutils literal">KEY_SRSUME</code></td>

1779

<td>Shifted Resume</td>

1780

</tr>

1781

<tr class="row-even"><td><code class="docutils literal">KEY_SSAVE</code></td>

1782

<td>Shifted Save</td>

1783

</tr>

1784

<tr class="row-odd"><td><code class="docutils literal">KEY_SSUSPEND</code></td>

1785

<td>Shifted Suspend</td>

1786

</tr>

1787

<tr class="row-even"><td><code class="docutils literal">KEY_SUNDO</code></td>

1788

<td>Shifted Undo</td>

1789

</tr>

1790

<tr class="row-odd"><td><code class="docutils literal">KEY_SUSPEND</code></td>

1791

<td>Suspend</td>

1792

</tr>

1793

1794

1795

</tr>

1796

<tr class="row-odd"><td><code class="docutils literal">KEY_MOUSE</code></td>

1797

<td>Mouse event has occurred</td>

1798

</tr>

1799

<tr class="row-even"><td><code class="docutils literal">KEY_RESIZE</code></td>

1800

<td>Terminal resize event</td>

1801

</tr>

1802

1803

<td>Maximum key value</td>

1804

</tr>

1805

</tbody>

1806

</table>

1807

On VT100s and their software emulations, such as X terminal emulators, there are

1808

normally at least four function keys (<code class="xref py py-const docutils literal">KEY_F1</code>, <code class="xref py py-const docutils literal">KEY_F2</code>,

1809

<code class="xref py py-const docutils literal">KEY_F3</code>, <code class="xref py py-const docutils literal">KEY_F4</code>) available, and the arrow keys mapped to

1810

<code class="xref py py-const docutils literal">KEY_UP</code>, <code class="xref py py-const docutils literal">KEY_DOWN</code>, <code class="xref py py-const docutils literal">KEY_LEFT</code> and <code class="xref py py-const docutils literal">KEY_RIGHT</code> in

1811

the obvious way. If your machine has a PC keyboard, it is safe to expect arrow

1812

keys and twelve function keys (older PC keyboards may have only ten function

1813

keys); also, the following keypad mappings are standard:

1814

1815

1816

1817

1818

</colgroup>

1819

1820

<tr class="row-odd"><th class="head">Keycap</th>

1821

<th class="head">Constant</th>

1822

</tr>

1823

</thead>

1824

1825

<tr class="row-even"><td><code class="kbd docutils literal">Insert</code></td>

1826

1827

</tr>

1828

<tr class="row-odd"><td><code class="kbd docutils literal">Delete</code></td>

1829

1830

</tr>

1831

1832

1833

</tr>

1834

1835

1836

</tr>

1837

1838

<td>KEY_PPAGE</td>

1839

</tr>

1840

1841

<td>KEY_NPAGE</td>

1842

</tr>

1843

</tbody>

1844

</table>

1845

The following table lists characters from the alternate character set. These are

1846

inherited from the VT100 terminal, and will generally be available on software

1847

emulations such as X terminals. When there is no graphic available, curses

1848

falls back on a crude printable ASCII approximation.

1849

1850

Note

1851

These are available only after <a class="reference internal" href="#curses.initscr" title="curses.initscr"><code class="xref py py-func docutils literal">initscr()</code></a> has been called.

1852

</div>

1853

1854

1855

1856

1857

</colgroup>

1858

1859

1860

<th class="head">Meaning</th>

1861

</tr>

1862

</thead>

1863

1864

1865

<td>alternate name for upper right corner</td>

1866

</tr>

1867

<tr class="row-odd"><td><code class="docutils literal">ACS_BLOCK</code></td>

1868

<td>solid square block</td>

1869

</tr>

1870

<tr class="row-even"><td><code class="docutils literal">ACS_BOARD</code></td>

1871

<td>board of squares</td>

1872

</tr>

1873

1874

<td>alternate name for horizontal line</td>

1875

</tr>

1876

1877

<td>alternate name for upper left corner</td>

1878

</tr>

1879

1880

<td>alternate name for top tee</td>

1881

</tr>

1882

1883

<td>bottom tee</td>

1884

</tr>

1885

<tr class="row-odd"><td><code class="docutils literal">ACS_BULLET</code></td>

1886

<td>bullet</td>

1887

</tr>

1888

<tr class="row-even"><td><code class="docutils literal">ACS_CKBOARD</code></td>

1889

<td>checker board (stipple)</td>

1890

</tr>

1891

<tr class="row-odd"><td><code class="docutils literal">ACS_DARROW</code></td>

1892

<td>arrow pointing down</td>

1893

</tr>

1894

<tr class="row-even"><td><code class="docutils literal">ACS_DEGREE</code></td>

1895

<td>degree symbol</td>

1896

</tr>

1897

<tr class="row-odd"><td><code class="docutils literal">ACS_DIAMOND</code></td>

1898

<td>diamond</td>

1899

</tr>

1900

<tr class="row-even"><td><code class="docutils literal">ACS_GEQUAL</code></td>

1901

<td>greater-than-or-equal-to</td>

1902

</tr>

1903

<tr class="row-odd"><td><code class="docutils literal">ACS_HLINE</code></td>

1904

<td>horizontal line</td>

1905

</tr>

1906

<tr class="row-even"><td><code class="docutils literal">ACS_LANTERN</code></td>

1907

<td>lantern symbol</td>

1908

</tr>

1909

<tr class="row-odd"><td><code class="docutils literal">ACS_LARROW</code></td>

1910

<td>left arrow</td>

1911

</tr>

1912

<tr class="row-even"><td><code class="docutils literal">ACS_LEQUAL</code></td>

1913

<td>less-than-or-equal-to</td>

1914

</tr>

1915

<tr class="row-odd"><td><code class="docutils literal">ACS_LLCORNER</code></td>

1916

<td>lower left-hand corner</td>

1917

</tr>

1918

<tr class="row-even"><td><code class="docutils literal">ACS_LRCORNER</code></td>

1919

<td>lower right-hand corner</td>

1920

</tr>

1921

1922

1923

</tr>

1924

<tr class="row-even"><td><code class="docutils literal">ACS_NEQUAL</code></td>

1925

<td>not-equal sign</td>

1926

</tr>

1927

1928

<td>letter pi</td>

1929

</tr>

1930

<tr class="row-even"><td><code class="docutils literal">ACS_PLMINUS</code></td>

1931

<td>plus-or-minus sign</td>

1932

</tr>

1933

1934

1935

</tr>

1936

<tr class="row-even"><td><code class="docutils literal">ACS_RARROW</code></td>

1937

<td>right arrow</td>

1938

</tr>

1939

1940

<td>right tee</td>

1941

</tr>

1942

1943

1944

</tr>

1945

1946

1947

</tr>

1948

1949

1950

</tr>

1951

1952

1953

</tr>

1954

1955

<td>alternate name for lower right corner</td>

1956

</tr>

1957

1958

<td>alternate name for vertical line</td>

1959

</tr>

1960

1961

<td>alternate name for right tee</td>

1962

</tr>

1963

1964

<td>alternate name for lower left corner</td>

1965

</tr>

1966

1967

<td>alternate name for bottom tee</td>

1968

</tr>

1969

1970

<td>alternate name for left tee</td>

1971

</tr>

1972

1973

<td>alternate name for crossover or big plus</td>

1974

</tr>

1975

<tr class="row-odd"><td><code class="docutils literal">ACS_STERLING</code></td>

1976

<td>pound sterling</td>

1977

</tr>

1978

1979

1980

</tr>

1981

<tr class="row-odd"><td><code class="docutils literal">ACS_UARROW</code></td>

1982

<td>up arrow</td>

1983

</tr>

1984

<tr class="row-even"><td><code class="docutils literal">ACS_ULCORNER</code></td>

1985

<td>upper left corner</td>

1986

</tr>

1987

<tr class="row-odd"><td><code class="docutils literal">ACS_URCORNER</code></td>

1988

<td>upper right corner</td>

1989

</tr>

1990

<tr class="row-even"><td><code class="docutils literal">ACS_VLINE</code></td>

1991

<td>vertical line</td>

1992

</tr>

1993

</tbody>

1994

</table>

1995

The following table lists the predefined colors:

1996

1997

1998

1999

2000

</colgroup>

2001

2002

<tr class="row-odd"><th class="head">Constant</th>

2003

<th class="head">Color</th>

2004

</tr>

2005

</thead>

2006

2007

<tr class="row-even"><td><code class="docutils literal">COLOR_BLACK</code></td>

2008

<td>Black</td>

2009

</tr>

2010

<tr class="row-odd"><td><code class="docutils literal">COLOR_BLUE</code></td>

2011

2012

</tr>

2013

<tr class="row-even"><td><code class="docutils literal">COLOR_CYAN</code></td>

2014

<td>Cyan (light greenish blue)</td>

2015

</tr>

2016

<tr class="row-odd"><td><code class="docutils literal">COLOR_GREEN</code></td>

2017

<td>Green</td>

2018

</tr>

2019

<tr class="row-even"><td><code class="docutils literal">COLOR_MAGENTA</code></td>

2020

<td>Magenta (purplish red)</td>

2021

</tr>

2022

<tr class="row-odd"><td><code class="docutils literal">COLOR_RED</code></td>

2023

2024

</tr>

2025

<tr class="row-even"><td><code class="docutils literal">COLOR_WHITE</code></td>

2026

<td>White</td>

2027

</tr>

2028

<tr class="row-odd"><td><code class="docutils literal">COLOR_YELLOW</code></td>

2029

<td>Yellow</td>

2030

</tr>

2031

</tbody>

2032

</table>

2033

</div>

2034

</div>

2035

2036

<h1>15.12. <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">curses.textpad</code></a> — Text input widget for curses programs<a class="headerlink" href="#module-curses.textpad" title="Permalink to this headline">¶</a></h1>

2037

2038

New in version 1.6.

2039

</div>

2040

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">curses.textpad</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">Textbox</code></a> class that handles

2041

elementary text editing in a curses window, supporting a set of keybindings

2042

resembling those of Emacs (thus, also of Netscape Navigator, BBedit 6.x,

2043

FrameMaker, and many other programs). The module also provides a

2044

rectangle-drawing function useful for framing text boxes or for other purposes.

2045

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">curses.textpad</code></a> defines the following function:

2046

2047

2048

<code class="descclassname">curses.textpad.</code><code class="descname">rectangle</code>(win, uly, ulx, lry, lrx)<a class="headerlink" href="#curses.textpad.rectangle" title="Permalink to this definition">¶</a></dt>

2049

<dd>Draw a rectangle. The first argument must be a window object; the remaining

2050

arguments are coordinates relative to that window. The second and third

2051

arguments are the y and x coordinates of the upper left hand corner of the

2052

rectangle to be drawn; the fourth and fifth arguments are the y and x

2053

coordinates of the lower right hand corner. The rectangle will be drawn using

2054

VT100/IBM PC forms characters on terminals that make this possible (including

2055

xterm and most other software terminal emulators). Otherwise it will be drawn

2056

with ASCII dashes, vertical bars, and plus signs.

2057

</dd></dl>

2058

2059

2060

<h2>15.12.1. Textbox objects<a class="headerlink" href="#textbox-objects" title="Permalink to this headline">¶</a></h2>

2061

You can instantiate a <a class="reference internal" href="#curses.textpad.Textbox" title="curses.textpad.Textbox"><code class="xref py py-class docutils literal">Textbox</code></a> object as follows:

2062

2063

2064

class <code class="descclassname">curses.textpad.</code><code class="descname">Textbox</code>(win)<a class="headerlink" href="#curses.textpad.Textbox" title="Permalink to this definition">¶</a></dt>

2065

<dd>Return a textbox widget object. The win argument should be a curses

2066

<code class="xref py py-class docutils literal">WindowObject</code> in which the textbox is to be contained. The edit cursor

2067

of the textbox is initially located at the upper left hand corner of the

2068

containing window, with coordinates <code class="docutils literal">(0, 0)</code>. The instance’s

2069

<a class="reference internal" href="#curses.textpad.Textbox.stripspaces" title="curses.textpad.Textbox.stripspaces"><code class="xref py py-attr docutils literal">stripspaces</code></a> flag is initially on.

2070

<a class="reference internal" href="#curses.textpad.Textbox" title="curses.textpad.Textbox"><code class="xref py py-class docutils literal">Textbox</code></a> objects have the following methods:

2071

2072

2073

<code class="descname">edit</code>([validator])<a class="headerlink" href="#curses.textpad.Textbox.edit" title="Permalink to this definition">¶</a></dt>

2074

<dd>This is the entry point you will normally use. It accepts editing

2075

keystrokes until one of the termination keystrokes is entered. If

2076

validator is supplied, it must be a function. It will be called for

2077

each keystroke entered with the keystroke as a parameter; command dispatch

2078

is done on the result. This method returns the window contents as a

2079

string; whether blanks in the window are included is affected by the

2080

2081

</dd></dl>

2082

2083

2084

2085

<code class="descname">do_command</code>(ch)<a class="headerlink" href="#curses.textpad.Textbox.do_command" title="Permalink to this definition">¶</a></dt>

2086

<dd>Process a single command keystroke. Here are the supported special

2087

keystrokes:

2088

2089

2090

2091

2092

</colgroup>

2093

2094

<tr class="row-odd"><th class="head">Keystroke</th>

2095

<th class="head">Action</th>

2096

</tr>

2097

</thead>

2098

2099

<tr class="row-even"><td><code class="kbd docutils literal">Control-A</code></td>

2100

<td>Go to left edge of window.</td>

2101

</tr>

2102

<tr class="row-odd"><td><code class="kbd docutils literal">Control-B</code></td>

2103

<td>Cursor left, wrapping to previous line if

2104

appropriate.</td>

2105

</tr>

2106

<tr class="row-even"><td><code class="kbd docutils literal">Control-D</code></td>

2107

<td>Delete character under cursor.</td>

2108

</tr>

2109

<tr class="row-odd"><td><code class="kbd docutils literal">Control-E</code></td>

2110

<td>Go to right edge (stripspaces off) or end

2111

of line (stripspaces on).</td>

2112

</tr>

2113

<tr class="row-even"><td><code class="kbd docutils literal">Control-F</code></td>

2114

<td>Cursor right, wrapping to next line when

2115

appropriate.</td>

2116

</tr>

2117

<tr class="row-odd"><td><code class="kbd docutils literal">Control-G</code></td>

2118

<td>Terminate, returning the window contents.</td>

2119

</tr>

2120

<tr class="row-even"><td><code class="kbd docutils literal">Control-H</code></td>

2121

<td>Delete character backward.</td>

2122

</tr>

2123

<tr class="row-odd"><td><code class="kbd docutils literal">Control-J</code></td>

2124

<td>Terminate if the window is 1 line,

2125

otherwise insert newline.</td>

2126

</tr>

2127

<tr class="row-even"><td><code class="kbd docutils literal">Control-K</code></td>

2128

<td>If line is blank, delete it, otherwise

2129

clear to end of line.</td>

2130

</tr>

2131

<tr class="row-odd"><td><code class="kbd docutils literal">Control-L</code></td>

2132

<td>Refresh screen.</td>

2133

</tr>

2134

<tr class="row-even"><td><code class="kbd docutils literal">Control-N</code></td>

2135

<td>Cursor down; move down one line.</td>

2136

</tr>

2137

<tr class="row-odd"><td><code class="kbd docutils literal">Control-O</code></td>

2138

<td>Insert a blank line at cursor location.</td>

2139

</tr>

2140

<tr class="row-even"><td><code class="kbd docutils literal">Control-P</code></td>

2141

<td>Cursor up; move up one line.</td>

2142

</tr>

2143

</tbody>

2144

</table>

2145

Move operations do nothing if the cursor is at an edge where the movement

2146

is not possible. The following synonyms are supported where possible:

2147

2148

2149

2150

2151

</colgroup>

2152

2153

<tr class="row-odd"><th class="head">Constant</th>

2154

<th class="head">Keystroke</th>

2155

</tr>

2156

</thead>

2157

2158

2159

<td><code class="kbd docutils literal">Control-B</code></td>

2160

</tr>

2161

<tr class="row-odd"><td><code class="xref py py-const docutils literal">KEY_RIGHT</code></td>

2162

<td><code class="kbd docutils literal">Control-F</code></td>

2163

</tr>

2164

2165

<td><code class="kbd docutils literal">Control-P</code></td>

2166

</tr>

2167

2168

<td><code class="kbd docutils literal">Control-N</code></td>

2169

</tr>

2170

<tr class="row-even"><td><code class="xref py py-const docutils literal">KEY_BACKSPACE</code></td>

2171

<td><code class="kbd docutils literal">Control-h</code></td>

2172

</tr>

2173

</tbody>

2174

</table>

2175

All other keystrokes are treated as a command to insert the given

2176

character and move right (with line wrapping).

2177

</dd></dl>

2178

2179

2180

2181

<code class="descname">gather</code>()<a class="headerlink" href="#curses.textpad.Textbox.gather" title="Permalink to this definition">¶</a></dt>

2182

<dd>Return the window contents as a string; whether blanks in the

2183

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">stripspaces</code></a> member.

2184

</dd></dl>

2185

2186

2187

2188

<code class="descname">stripspaces</code><a class="headerlink" href="#curses.textpad.Textbox.stripspaces" title="Permalink to this definition">¶</a></dt>

2189

<dd>This attribute is a flag which controls the interpretation of blanks in

2190

the window. When it is on, trailing blanks on each line are ignored; any

2191

cursor motion that would land the cursor on a trailing blank goes to the

2192

end of that line instead, and trailing blanks are stripped when the window

2193

contents are gathered.

2194

</dd></dl>

2195

2196

</dd></dl>

2197

2198

</div>

2199

</div>

2200

2201

2202

</div>

2203

</div>

2204

</div>

2205

2206

2207

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

2208

<ul>

2209

<li><a class="reference internal" href="#">15.11. <code class="docutils literal">curses</code> — Terminal handling for character-cell displays</a><ul>

2210

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

2211

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

2212

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

2213

</ul>

2214

</li>

2215

<li><a class="reference internal" href="#module-curses.textpad">15.12. <code class="docutils literal">curses.textpad</code> — Text input widget for curses programs</a><ul>

2216

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

2217

</ul>

2218

</li>

2219

</ul>

2220

2221

<h4>Previous topic</h4>

2222

<a href="getpass.html"

2223

title="previous chapter">15.10. <code class="docutils literal">getpass</code> — Portable password input</a>

2224

<h4>Next topic</h4>

2225

<a href="curses.ascii.html"

2226

title="next chapter">15.13. <code class="docutils literal">curses.ascii</code> — Utilities for ASCII characters</a>

2227

2228

2229

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

2230

<li><a href="../_sources/library/curses.txt"

2231

rel="nofollow">Show Source</a></li>

2232

</ul>

2233

2234

2235

<h3>Quick search</h3>

2236

2237

2238

2239

2240

2241

</form>

2242

2243

Enter search terms or a module, class or function name.

2244

2245

</div>

2246

2247

</div>

2248

</div>

2249

2250

</div>

2251

2252

<h3>Navigation</h3>

2253

<ul>

2254

2255

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

2256

>index</a></li>

2257

2258

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

2259

>modules</a> |</li>

2260

2261

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

2262

>next</a> |</li>

2263

2264

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

2265

>previous</a> |</li>

2266

<li><img src="../_static/py.png" alt=""

2267

style="vertical-align: middle; margin-top: -1px"/></li>

2268

<li><a href="https://www.python.org/">Python</a> »</li>

2269

<li>

2270

2.7.12

2271

<a href="../index.html">Documentation</a> »

2272

</li>

2273

2274

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li>

2275

<li class="nav-item nav-item-2"><a href="allos.html" >15. Generic Operating System Services</a> »</li>

2276

</ul>

2277

</div>

2278

2279

2280

2281

The Python Software Foundation is a non-profit corporation.

2282

<a href="https://www.python.org/psf/donations/">Please donate.</a>

2283

2284

Last updated on Nov 26, 2016.

2285

<a href="../bugs.html">Found a bug</a>?

2286

2287

Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.3.3.

2288

</div>

2289

2290

</body>

2291

</html>

b'\\ No newline at end of file'

Older »