1
<?xml version="1.0" encoding="ascii"?>
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
"DTD/xhtml1-transitional.dtd">
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
<title>epydoc.cli.TerminalController</title>
7
<link rel="stylesheet" href="epydoc.css" type="text/css" />
8
<script type="text/javascript" src="epydoc.js"></script>
11
<body bgcolor="white" text="black" link="blue" vlink="#204080"
13
<!-- ==================== NAVIGATION BAR ==================== -->
14
<table class="navbar" border="0" width="100%" cellpadding="0"
15
bgcolor="#a0c0ff" cellspacing="0">
18
<th> <a
19
href="epydoc-module.html">Home</a> </th>
22
<th> <a
23
href="module-tree.html">Trees</a> </th>
26
<th> <a
27
href="identifier-index.html">Indices</a> </th>
30
<th> <a
31
href="help.html">Help</a> </th>
33
<!-- Project homepage -->
34
<th class="navbar" align="right" width="100%">
35
<table border="0" cellpadding="0" cellspacing="0">
36
<tr><th class="navbar" align="center"
37
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
41
<table width="100%" cellpadding="0" cellspacing="0">
44
<span class="breadcrumbs">
45
<a href="epydoc-module.html">Package epydoc</a> ::
46
<a href="epydoc.cli-module.html">Module cli</a> ::
47
Class TerminalController
51
<table cellpadding="0" cellspacing="0">
52
<!-- hide/show private -->
53
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
54
onclick="toggle_private();">hide private</a>]</span></td></tr>
55
<tr><td align="right"><span class="options"
56
>[<a href="frames.html" target="_top">frames</a
57
>] | <a href="epydoc.cli.TerminalController-class.html"
58
target="_top">no frames</a>]</span></td></tr>
63
<!-- ==================== CLASS DESCRIPTION ==================== -->
64
<h1 class="epydoc">Class TerminalController</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc.cli-pysrc.html#TerminalController">source code</a></span></p>
65
<p>A class that can be used to portably generate formatted output to a
67
href="http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/475116"
68
target="_top">http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/475116</a>
69
for documentation. (This is a somewhat stripped-down version.)</p>
71
<!-- ==================== INSTANCE METHODS ==================== -->
72
<a name="section-InstanceMethods"></a>
73
<table class="summary" border="1" cellpadding="3"
74
cellspacing="0" width="100%" bgcolor="white">
75
<tr bgcolor="#70b0f0" class="table-header">
76
<td colspan="2" class="table-header">
77
<table border="0" cellpadding="0" cellspacing="0" width="100%">
79
<td align="left"><span class="table-header">Instance Methods</span></td>
80
<td align="right" valign="top"
81
><span class="options">[<a href="#section-InstanceMethods"
82
class="privatelink" onclick="toggle_private();"
83
>hide private</a>]</span></td>
89
<td width="15%" align="right" valign="top" class="summary">
90
<span class="summary-type"> </span>
91
</td><td class="summary">
92
<table width="100%" cellpadding="0" cellspacing="0" border="0">
94
<td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>,
95
<span class="summary-sig-arg">term_stream</span>=<span class="summary-sig-default">sys.stdout</span>)</span></td>
96
<td align="right" valign="top">
97
<span class="codelink"><a href="epydoc.cli-pysrc.html#TerminalController.__init__">source code</a></span>
106
<td width="15%" align="right" valign="top" class="summary">
107
<span class="summary-type"> </span>
108
</td><td class="summary">
109
<table width="100%" cellpadding="0" cellspacing="0" border="0">
111
<td><span class="summary-sig"><a name="_tigetstr"></a><span class="summary-sig-name">_tigetstr</span>(<span class="summary-sig-arg">self</span>,
112
<span class="summary-sig-arg">cap_name</span>)</span></td>
113
<td align="right" valign="top">
114
<span class="codelink"><a href="epydoc.cli-pysrc.html#TerminalController._tigetstr">source code</a></span>
123
<!-- ==================== CLASS VARIABLES ==================== -->
124
<a name="section-ClassVariables"></a>
125
<table class="summary" border="1" cellpadding="3"
126
cellspacing="0" width="100%" bgcolor="white">
127
<tr bgcolor="#70b0f0" class="table-header">
128
<td colspan="2" class="table-header">
129
<table border="0" cellpadding="0" cellspacing="0" width="100%">
131
<td align="left"><span class="table-header">Class Variables</span></td>
132
<td align="right" valign="top"
133
><span class="options">[<a href="#section-ClassVariables"
134
class="privatelink" onclick="toggle_private();"
135
>hide private</a>]</span></td>
141
<td width="15%" align="right" valign="top" class="summary">
142
<span class="summary-type"> </span>
143
</td><td class="summary">
144
<a name="BOL"></a><span class="summary-name">BOL</span> = <code title="''"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></code><br />
145
Move the cursor to the beginning of the line
149
<td width="15%" align="right" valign="top" class="summary">
150
<span class="summary-type"> </span>
151
</td><td class="summary">
152
<a name="UP"></a><span class="summary-name">UP</span> = <code title="''"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></code><br />
153
Move the cursor up one line
157
<td width="15%" align="right" valign="top" class="summary">
158
<span class="summary-type"> </span>
159
</td><td class="summary">
160
<a name="DOWN"></a><span class="summary-name">DOWN</span> = <code title="''"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></code><br />
161
Move the cursor down one line
165
<td width="15%" align="right" valign="top" class="summary">
166
<span class="summary-type"> </span>
167
</td><td class="summary">
168
<a name="LEFT"></a><span class="summary-name">LEFT</span> = <code title="''"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></code><br />
169
Move the cursor left one char
173
<td width="15%" align="right" valign="top" class="summary">
174
<span class="summary-type"> </span>
175
</td><td class="summary">
176
<a name="RIGHT"></a><span class="summary-name">RIGHT</span> = <code title="''"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></code><br />
177
Move the cursor right one char
181
<td width="15%" align="right" valign="top" class="summary">
182
<span class="summary-type"> </span>
183
</td><td class="summary">
184
<a name="CLEAR_EOL"></a><span class="summary-name">CLEAR_EOL</span> = <code title="''"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></code><br />
185
Clear to the end of the line.
189
<td width="15%" align="right" valign="top" class="summary">
190
<span class="summary-type"> </span>
191
</td><td class="summary">
192
<a name="CLEAR_LINE"></a><span class="summary-name">CLEAR_LINE</span> = <code title="''"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></code><br />
193
Clear the current line; cursor to BOL.
197
<td width="15%" align="right" valign="top" class="summary">
198
<span class="summary-type"> </span>
199
</td><td class="summary">
200
<a name="BOLD"></a><span class="summary-name">BOLD</span> = <code title="''"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></code><br />
205
<td width="15%" align="right" valign="top" class="summary">
206
<span class="summary-type"> </span>
207
</td><td class="summary">
208
<a name="NORMAL"></a><span class="summary-name">NORMAL</span> = <code title="''"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></code><br />
213
<td width="15%" align="right" valign="top" class="summary">
214
<span class="summary-type"> </span>
215
</td><td class="summary">
216
<a name="COLS"></a><span class="summary-name">COLS</span> = <code title="75">75</code><br />
217
Width of the terminal (default to 75)
221
<td width="15%" align="right" valign="top" class="summary">
222
<span class="summary-type"> </span>
223
</td><td class="summary">
224
<a name="WHITE"></a><span class="summary-name">WHITE</span> = <code title="''"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></code>
228
<td width="15%" align="right" valign="top" class="summary">
229
<span class="summary-type"> </span>
230
</td><td class="summary">
231
<a name="YELLOW"></a><span class="summary-name">YELLOW</span> = <code title="''"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></code>
235
<td width="15%" align="right" valign="top" class="summary">
236
<span class="summary-type"> </span>
237
</td><td class="summary">
238
<a name="MAGENTA"></a><span class="summary-name">MAGENTA</span> = <code title="''"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></code>
242
<td width="15%" align="right" valign="top" class="summary">
243
<span class="summary-type"> </span>
244
</td><td class="summary">
245
<a name="RED"></a><span class="summary-name">RED</span> = <code title="''"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></code>
249
<td width="15%" align="right" valign="top" class="summary">
250
<span class="summary-type"> </span>
251
</td><td class="summary">
252
<a name="CYAN"></a><span class="summary-name">CYAN</span> = <code title="''"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></code>
256
<td width="15%" align="right" valign="top" class="summary">
257
<span class="summary-type"> </span>
258
</td><td class="summary">
259
<a name="GREEN"></a><span class="summary-name">GREEN</span> = <code title="''"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></code>
263
<td width="15%" align="right" valign="top" class="summary">
264
<span class="summary-type"> </span>
265
</td><td class="summary">
266
<a name="BLUE"></a><span class="summary-name">BLUE</span> = <code title="''"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></code>
270
<td width="15%" align="right" valign="top" class="summary">
271
<span class="summary-type"> </span>
272
</td><td class="summary">
273
<a name="BLACK"></a><span class="summary-name">BLACK</span> = <code title="''"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></code>
277
<td width="15%" align="right" valign="top" class="summary">
278
<span class="summary-type"> </span>
279
</td><td class="summary">
280
<a href="epydoc.cli.TerminalController-class.html#_STRING_CAPABILITIES" class="summary-name" onclick="show_private();">_STRING_CAPABILITIES</a> = <code title="['BOL=cr',
288
..."><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">BOL=cr</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">UP=cuu1</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">DOWN=cud1</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">LEF</code><code class="variable-ellipsis">...</code></code>
292
<td width="15%" align="right" valign="top" class="summary">
293
<span class="summary-type"> </span>
294
</td><td class="summary">
295
<a href="epydoc.cli.TerminalController-class.html#_COLORS" class="summary-name" onclick="show_private();">_COLORS</a> = <code title="['BLACK',
302
'WHITE']"><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">BLACK</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">BLUE</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">GREEN</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">CYAN</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">RED</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">MAGENTA</code><code class="variable-quote">'</code><code class="variable-op">,</code><code class="variable-ellipsis">...</code></code>
306
<td width="15%" align="right" valign="top" class="summary">
307
<span class="summary-type"> </span>
308
</td><td class="summary">
309
<a href="epydoc.cli.TerminalController-class.html#_ANSICOLORS" class="summary-name" onclick="show_private();">_ANSICOLORS</a> = <code title="['BLACK',
316
'WHITE']"><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">BLACK</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">RED</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">GREEN</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">YELLOW</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">BLUE</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">MAG</code><code class="variable-ellipsis">...</code></code>
320
<td width="15%" align="right" valign="top" class="summary">
321
<span class="summary-type"> </span>
322
</td><td class="summary">
323
<a name="FORCE_SIMPLE_TERM"></a><span class="summary-name">FORCE_SIMPLE_TERM</span> = <code title="False">False</code><br />
324
If this is set to true, then new TerminalControllers will assume that
325
the terminal is not capable of doing manipulation of any kind.
329
<!-- ==================== CLASS VARIABLE DETAILS ==================== -->
330
<a name="section-ClassVariableDetails"></a>
331
<table class="details" border="1" cellpadding="3"
332
cellspacing="0" width="100%" bgcolor="white">
333
<tr bgcolor="#70b0f0" class="table-header">
334
<td colspan="2" class="table-header">
335
<table border="0" cellpadding="0" cellspacing="0" width="100%">
337
<td align="left"><span class="table-header">Class Variable Details</span></td>
338
<td align="right" valign="top"
339
><span class="options">[<a href="#section-ClassVariableDetails"
340
class="privatelink" onclick="toggle_private();"
341
>hide private</a>]</span></td>
347
<a name="_STRING_CAPABILITIES"></a>
348
<div class="private">
349
<table class="details" border="1" cellpadding="3"
350
cellspacing="0" width="100%" bgcolor="white">
352
<h3 class="epydoc">_STRING_CAPABILITIES</h3>
358
<dd><table><tr><td><pre class="variable">
359
<code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">BOL=cr</code><code class="variable-quote">'</code><code class="variable-op">,</code>
360
<code class="variable-quote">'</code><code class="variable-string">UP=cuu1</code><code class="variable-quote">'</code><code class="variable-op">,</code>
361
<code class="variable-quote">'</code><code class="variable-string">DOWN=cud1</code><code class="variable-quote">'</code><code class="variable-op">,</code>
362
<code class="variable-quote">'</code><code class="variable-string">LEFT=cub1</code><code class="variable-quote">'</code><code class="variable-op">,</code>
363
<code class="variable-quote">'</code><code class="variable-string">RIGHT=cuf1</code><code class="variable-quote">'</code><code class="variable-op">,</code>
364
<code class="variable-quote">'</code><code class="variable-string">CLEAR_EOL=el</code><code class="variable-quote">'</code><code class="variable-op">,</code>
365
<code class="variable-quote">'</code><code class="variable-string">BOLD=bold</code><code class="variable-quote">'</code><code class="variable-op">,</code>
366
<code class="variable-quote">'</code><code class="variable-string">UNDERLINE=smul</code><code class="variable-quote">'</code><code class="variable-op">,</code>
367
<code class="variable-ellipsis">...</code>
368
</pre></td></tr></table>
373
<a name="_COLORS"></a>
374
<div class="private">
375
<table class="details" border="1" cellpadding="3"
376
cellspacing="0" width="100%" bgcolor="white">
378
<h3 class="epydoc">_COLORS</h3>
384
<dd><table><tr><td><pre class="variable">
385
<code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">BLACK</code><code class="variable-quote">'</code><code class="variable-op">,</code>
386
<code class="variable-quote">'</code><code class="variable-string">BLUE</code><code class="variable-quote">'</code><code class="variable-op">,</code>
387
<code class="variable-quote">'</code><code class="variable-string">GREEN</code><code class="variable-quote">'</code><code class="variable-op">,</code>
388
<code class="variable-quote">'</code><code class="variable-string">CYAN</code><code class="variable-quote">'</code><code class="variable-op">,</code>
389
<code class="variable-quote">'</code><code class="variable-string">RED</code><code class="variable-quote">'</code><code class="variable-op">,</code>
390
<code class="variable-quote">'</code><code class="variable-string">MAGENTA</code><code class="variable-quote">'</code><code class="variable-op">,</code>
391
<code class="variable-quote">'</code><code class="variable-string">YELLOW</code><code class="variable-quote">'</code><code class="variable-op">,</code>
392
<code class="variable-quote">'</code><code class="variable-string">WHITE</code><code class="variable-quote">'</code><code class="variable-group">]</code>
393
</pre></td></tr></table>
398
<a name="_ANSICOLORS"></a>
399
<div class="private">
400
<table class="details" border="1" cellpadding="3"
401
cellspacing="0" width="100%" bgcolor="white">
403
<h3 class="epydoc">_ANSICOLORS</h3>
409
<dd><table><tr><td><pre class="variable">
410
<code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">BLACK</code><code class="variable-quote">'</code><code class="variable-op">,</code>
411
<code class="variable-quote">'</code><code class="variable-string">RED</code><code class="variable-quote">'</code><code class="variable-op">,</code>
412
<code class="variable-quote">'</code><code class="variable-string">GREEN</code><code class="variable-quote">'</code><code class="variable-op">,</code>
413
<code class="variable-quote">'</code><code class="variable-string">YELLOW</code><code class="variable-quote">'</code><code class="variable-op">,</code>
414
<code class="variable-quote">'</code><code class="variable-string">BLUE</code><code class="variable-quote">'</code><code class="variable-op">,</code>
415
<code class="variable-quote">'</code><code class="variable-string">MAGENTA</code><code class="variable-quote">'</code><code class="variable-op">,</code>
416
<code class="variable-quote">'</code><code class="variable-string">CYAN</code><code class="variable-quote">'</code><code class="variable-op">,</code>
417
<code class="variable-quote">'</code><code class="variable-string">WHITE</code><code class="variable-quote">'</code><code class="variable-group">]</code>
418
</pre></td></tr></table>
424
<!-- ==================== NAVIGATION BAR ==================== -->
425
<table class="navbar" border="0" width="100%" cellpadding="0"
426
bgcolor="#a0c0ff" cellspacing="0">
429
<th> <a
430
href="epydoc-module.html">Home</a> </th>
433
<th> <a
434
href="module-tree.html">Trees</a> </th>
437
<th> <a
438
href="identifier-index.html">Indices</a> </th>
441
<th> <a
442
href="help.html">Help</a> </th>
444
<!-- Project homepage -->
445
<th class="navbar" align="right" width="100%">
446
<table border="0" cellpadding="0" cellspacing="0">
447
<tr><th class="navbar" align="center"
448
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
452
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
454
<td align="left" class="footer">
455
<a href="epydoc-log.html">Generated by Epydoc
456
3.0.1 on Wed Jan 30 14:07:36 2008</a>
458
<td align="right" class="footer">
459
<a target="mainFrame" href="http://epydoc.sourceforge.net"
460
>http://epydoc.sourceforge.net</a>
465
<script type="text/javascript">
467
// Private objects are initially displayed (because if
468
// javascript is turned off then we want them to be
469
// visible); but by default, we want to hide them. So hide
470
// them unless we have a cookie that says to show them.