about summary refs log tree commit diff stats
path: root/doc/curses.html
blob: 04bbb48c35a8dd1e869d2608628d7f2909b8c515 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: package curses</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">

<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>curses</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/lib/python3.1/curses/__init__.py">/usr/lib/python3.1/curses/__init__.py</a><br><a href="http://docs.python.org/library/curses">Module Docs</a></font></td></tr></table>
    <p><tt>curses<br>
&nbsp;<br>
The&nbsp;main&nbsp;package&nbsp;for&nbsp;curses&nbsp;support&nbsp;for&nbsp;Python.&nbsp;&nbsp;Normally&nbsp;used&nbsp;by&nbsp;importing<br>
the&nbsp;package,&nbsp;and&nbsp;perhaps&nbsp;a&nbsp;particular&nbsp;module&nbsp;inside&nbsp;it.<br>
&nbsp;<br>
&nbsp;&nbsp;&nbsp;import&nbsp;curses<br>
&nbsp;&nbsp;&nbsp;from&nbsp;curses&nbsp;import&nbsp;textpad<br>
&nbsp;&nbsp;&nbsp;curses.initwin()<br>
&nbsp;&nbsp;&nbsp;...</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
    
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="curses.ascii.html">ascii</a><br>
<a href="curses.has_key.html">has_key</a><br>
</td><td width="25%" valign=top><a href="curses.panel.html">panel</a><br>
<a href="curses.textpad.html">textpad</a><br>
</td><td width="25%" valign=top><a href="curses.wrapper.html">wrapper</a><br>
</td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#eeaa77">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
    
<tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl><dt><a name="-baudrate"><strong>baudrate</strong></a>(...)</dt></dl>
 <dl><dt><a name="-beep"><strong>beep</strong></a>(...)</dt></dl>
 <dl><dt><a name="-can_change_color"><strong>can_change_color</strong></a>(...)</dt></dl>
 <dl><dt><a name="-cbreak"><strong>cbreak</strong></a>(...)</dt></dl>
 <dl><dt><a name="-color_content"><strong>color_content</strong></a>(...)</dt></dl>
 <dl><dt><a name="-color_pair"><strong>color_pair</strong></a>(...)</dt></dl>
 <dl><dt><a name="-curs_set"><strong>curs_set</strong></a>(...)</dt></dl>
 <dl><dt><a name="-def_prog_mode"><strong>def_prog_mode</strong></a>(...)</dt></dl>
 <dl><dt><a name="-def_shell_mode"><strong>def_shell_mode</strong></a>(...)</dt></dl>
 <dl><dt><a name="-delay_output"><strong>delay_output</strong></a>(...)</dt></dl>
 <dl><dt><a name="-doupdate"><strong>doupdate</strong></a>(...)</dt></dl>
 <dl><dt><a name="-echo"><strong>echo</strong></a>(...)</dt></dl>
 <dl><dt><a name="-endwin"><strong>endwin</strong></a>(...)</dt></dl>
 <dl><dt><a name="-erasechar"><strong>erasechar</strong></a>(...)</dt></dl>
 <dl><dt><a name="-filter"><strong>filter</strong></a>(...)</dt></dl>
 <dl><dt><a name="-flash"><strong>flash</strong></a>(...)</dt></dl>
 <dl><dt><a name="-flushinp"><strong>flushinp</strong></a>(...)</dt></dl>
 <dl><dt><a name="-getmouse"><strong>getmouse</strong></a>(...)</dt></dl>
 <dl><dt><a name="-getsyx"><strong>getsyx</strong></a>(...)</dt></dl>
 <dl><dt><a name="-getwin"><strong>getwin</strong></a>(...)</dt></dl>
 <dl><dt><a name="-halfdelay"><strong>halfdelay</strong></a>(...)</dt></dl>
 <dl><dt><a name="-has_colors"><strong>has_colors</strong></a>(...)</dt></dl>
 <dl><dt><a name="-has_ic"><strong>has_ic</strong></a>(...)</dt></dl>
 <dl><dt><a name="-has_il"><strong>has_il</strong></a>(...)</dt></dl>
 <dl><dt><a name="-has_key"><strong>has_key</strong></a>(...)</dt></dl>
 <dl><dt><a name="-init_color"><strong>init_color</strong></a>(...)</dt></dl>
 <dl><dt><a name="-init_pair"><strong>init_pair</strong></a>(...)</dt></dl>
 <dl><dt><a name="-initscr"><strong>initscr</strong></a>()</dt></dl>
 <dl><dt><a name="-intrflush"><strong>intrflush</strong></a>(...)</dt></dl>
 <dl><dt><a name="-is_term_resized"><strong>is_term_resized</strong></a>(...)</dt></dl>
 <dl><dt><a name="-isendwin"><strong>isendwin</strong></a>(...)</dt></dl>
 <dl><dt><a name="-keyname"><strong>keyname</strong></a>(...)</dt></dl>
 <dl><dt><a name="-killchar"><strong>killchar</strong></a>(...)</dt></dl>
 <dl><dt><a name="-longname"><strong>longname</strong></a>(...)</dt></dl>
 <dl><dt><a name="-meta"><strong>meta</strong></a>(...)</dt></dl>
 <dl><dt><a name="-mouseinterval"><strong>mouseinterval</strong></a>(...)</dt></dl>
 <dl><dt><a name="-mousemask"><strong>mousemask</strong></a>(...)</dt></dl>
 <dl><dt><a name="-napms"><strong>napms</strong></a>(...)</dt></dl>
 <dl><dt><a name="-newpad"><strong>newpad</strong></a>(...)</dt></dl>
 <dl><dt><a name="-newwin"><strong>newwin</strong></a>(...)</dt></dl>
 <dl><dt><a name="-nl"><strong>nl</strong></a>(...)</dt></dl>
 <dl><dt><a name="-nocbreak"><strong>nocbreak</strong></a>(...)</dt></dl>
 <dl><dt><a name="-noecho"><strong>noecho</strong></a>(...)</dt></dl>
 <dl><dt><a name="-nonl"><strong>nonl</strong></a>(...)</dt></dl>
 <dl><dt><a name="-noqiflush"><strong>noqiflush</strong></a>(...)</dt></dl>
 <dl><dt><a name="-noraw"><strong>noraw</strong></a>(...)</dt></dl>
 <dl><dt><a name="-pair_content"><strong>pair_content</strong></a>(...)</dt></dl>
 <dl><dt><a name="-pair_number"><strong>pair_number</strong></a>(...)</dt></dl>
 <dl><dt><a name="-putp"><strong>putp</strong></a>(...)</dt></dl>
 <dl><dt><a name="-qiflush"><strong>qiflush</strong></a>(...)</dt></dl>
 <dl><dt><a name="-raw"><strong>raw</strong></a>(...)</dt></dl>
 <dl><dt><a name="-reset_prog_mode"><strong>reset_prog_mode</strong></a>(...)</dt></dl>
 <dl><dt><a name="-reset_shell_mode"><strong>reset_shell_mode</strong></a>(...)</dt></dl>
 <dl><dt><a name="-resetty"><strong>resetty</strong></a>(...)</dt></dl>
 <dl><dt><a name="-resize_term"><strong>resize_term</strong></a>(...)</dt></dl>
 <dl><dt><a name="-resizeterm"><strong>resizeterm</strong></a>(...)</dt></dl>
 <dl><dt><a name="-savetty"><strong>savetty</strong></a>(...)</dt></dl>
 <dl><dt><a name="-setsyx"><strong>setsyx</strong></a>(...)</dt></dl>
 <dl><dt><a name="-setupterm"><strong>setupterm</strong></a>(...)</dt></dl>
 <dl><dt><a name="-start_color"><strong>start_color</strong></a>()</dt></dl>
 <dl><dt><a name="-termattrs"><strong>termattrs</strong></a>(...)</dt></dl>
 <dl><dt><a name="-termname"><strong>termname</strong></a>(...)</dt></dl>
 <dl><dt><a name="-tigetflag"><strong>tigetflag</strong></a>(...)</dt></dl>
 <dl><dt><a name="-tigetnum"><strong>tigetnum</strong></a>(...)</dt></dl>
 <dl><dt><a name="-tigetstr"><strong>tigetstr</strong></a>(...)</dt></dl>
 <dl><dt><a name="-tparm"><strong>tparm</strong></a>(...)</dt></dl>
 <dl><dt><a name="-typeahead"><strong>typeahead</strong></a>(...)</dt></dl>
 <dl><dt><a name="-unctrl"><strong>unctrl</strong></a>(...)</dt></dl>
 <dl><dt><a name="-ungetch"><strong>ungetch</strong></a>(...)</dt></dl>
 <dl><dt><a name="-ungetmouse"><strong>ungetmouse</strong></a>(...)</dt></dl>
 <dl><dt><a name="-use_default_colors"><strong>use_default_colors</strong></a>(...)</dt></dl>
 <dl><dt><a name="-use_env"><strong>use_env</strong></a>(...)</dt></dl>
</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
    
<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><strong>ALL_MOUSE_EVENTS</strong> = 134217727<br>
<strong>A_ALTCHARSET</strong> = 4194304<br>
<strong>A_ATTRIBUTES</strong> = 4294967040<br>
<strong>A_BLINK</strong> = 524288<br>
<strong>A_BOLD</strong> = 2097152<br>
<strong>A_CHARTEXT</strong> = 255<br>
<strong>A_COLOR</strong> = 65280<br>
<strong>A_DIM</strong> = 1048576<br>
<strong>A_HORIZONTAL</strong> = 33554432<br>
<strong>A_INVIS</strong> = 8388608<br>
<strong>A_LEFT</strong> = 67108864<br>
<strong>A_LOW</strong> = 134217728<br>
<strong>A_NORMAL</strong> = 0<br>
<strong>A_PROTECT</strong> = 16777216<br>
<strong>A_REVERSE</strong> = 262144<br>
<strong>A_RIGHT</strong> = 268435456<br>
<strong>A_STANDOUT</strong> = 65536<br>
<strong>A_TOP</strong> = 536870912<br>
<strong>A_UNDERLINE</strong> = 131072<br>
<strong>A_VERTICAL</strong> = 1073741824<br>
<strong>BUTTON1_CLICKED</strong> = 4<br>
<strong>BUTTON1_DOUBLE_CLICKED</strong> = 8<br>
<strong>BUTTON1_PRESSED</strong> = 2<br>
<strong>BUTTON1_RELEASED</strong> = 1<br>
<strong>BUTTON1_TRIPLE_CLICKED</strong> = 16<br>
<strong>BUTTON2_CLICKED</strong> = 256<br>
<strong>BUTTON2_DOUBLE_CLICKED</strong> = 512<br>
<strong>BUTTON2_PRESSED</strong> = 128<br>
<strong>BUTTON2_RELEASED</strong> = 64<br>
<strong>BUTTON2_TRIPLE_CLICKED</strong> = 1024<br>
<strong>BUTTON3_CLICKED</strong> = 16384<br>
<strong>BUTTON3_DOUBLE_CLICKED</strong> = 32768<br>
<strong>BUTTON3_PRESSED</strong> = 8192<br>
<strong>BUTTON3_RELEASED</strong> = 4096<br>
<strong>BUTTON3_TRIPLE_CLICKED</strong> = 65536<br>
<strong>BUTTON4_CLICKED</strong> = 1048576<br>
<strong>BUTTON4_DOUBLE_CLICKED</strong> = 2097152<br>
<strong>BUTTON4_PRESSED</strong> = 524288<br>
<strong>BUTTON4_RELEASED</strong> = 262144<br>
<strong>BUTTON4_TRIPLE_CLICKED</strong> = 4194304<br>
<strong>BUTTON_ALT</strong> = 67108864<br>
<strong>BUTTON_CTRL</strong> = 16777216<br>
<strong>BUTTON_SHIFT</strong> = 33554432<br>
<strong>COLOR_BLACK</strong> = 0<br>
<strong>COLOR_BLUE</strong> = 4<br>
<strong>COLOR_CYAN</strong> = 6<br>
<strong>COLOR_GREEN</strong> = 2<br>
<strong>COLOR_MAGENTA</strong> = 5<br>
<strong>COLOR_RED</strong> = 1<br>
<strong>COLOR_WHITE</strong> = 7<br>
<strong>COLOR_YELLOW</strong> = 3<br>
<strong>ERR</strong> = -1<br>
<strong>KEY_A1</strong> = 348<br>
<strong>KEY_A3</strong> = 349<br>
<strong>KEY_B2</strong> = 350<br>
<strong>KEY_BACKSPACE</strong> = 263<br>
<strong>KEY_BEG</strong> = 354<br>
<strong>KEY_BREAK</strong> = 257<br>
<strong>KEY_BTAB</strong> = 353<br>
<strong>KEY_C1</strong> = 351<br>
<strong>KEY_C3</strong> = 352<br>
<strong>KEY_CANCEL</strong> = 355<br>
<strong>KEY_CATAB</strong> = 342<br>
<strong>KEY_CLEAR</strong> = 333<br>
<strong>KEY_CLOSE</strong> = 356<br>
<strong>KEY_COMMAND</strong> = 357<br>
<strong>KEY_COPY</strong> = 358<br>
<strong>KEY_CREATE</strong> = 359<br>
<strong>KEY_CTAB</strong> = 341<br>
<strong>KEY_DC</strong> = 330<br>
<strong>KEY_DL</strong> = 328<br>
<strong>KEY_DOWN</strong> = 258<br>
<strong>KEY_EIC</strong> = 332<br>
<strong>KEY_END</strong> = 360<br>
<strong>KEY_ENTER</strong> = 343<br>
<strong>KEY_EOL</strong> = 335<br>
<strong>KEY_EOS</strong> = 334<br>
<strong>KEY_EXIT</strong> = 361<br>
<strong>KEY_F0</strong> = 264<br>
<strong>KEY_F1</strong> = 265<br>
<strong>KEY_F10</strong> = 274<br>
<strong>KEY_F11</strong> = 275<br>
<strong>KEY_F12</strong> = 276<br>
<strong>KEY_F13</strong> = 277<br>
<strong>KEY_F14</strong> = 278<br>
<strong>KEY_F15</strong> = 279<br>
<strong>KEY_F16</strong> = 280<br>
<strong>KEY_F17</strong> = 281<br>
<strong>KEY_F18</strong> = 282<br>
<strong>KEY_F19</strong> = 283<br>
<strong>KEY_F2</strong> = 266<br>
<strong>KEY_F20</strong> = 284<br>
<strong>KEY_F21</strong> = 285<br>
<strong>KEY_F22</strong> = 286<br>
<strong>KEY_F23</strong> = 287<br>
<strong>KEY_F24</strong> = 288<br>
<strong>KEY_F25</strong> = 289<br>
<strong>KEY_F26</strong> = 290<br>
<strong>KEY_F27</strong> = 291<br>
<strong>KEY_F28</strong> = 292<br>
<strong>KEY_F29</strong> = 293<br>
<strong>KEY_F3</strong> = 267<br>
<strong>KEY_F30</strong> = 294<br>
<strong>KEY_F31</strong> = 295<br>
<strong>KEY_F32</strong> = 296<br>
<strong>KEY_F33</strong> = 297<br>
<strong>KEY_F34</strong> = 298<br>
<strong>KEY_F35</strong> = 299<br>
<strong>KEY_F36</strong> = 300<br>
<strong>KEY_F37</strong> = 301<br>
<strong>KEY_F38</strong> = 302<br>
<strong>KEY_F39</strong> = 303<br>
<strong>KEY_F4</strong> = 268<br>
<strong>KEY_F40</strong> = 304<br>
<strong>KEY_F41</strong> = 305<br>
<strong>KEY_F42</strong> = 306<br>
<strong>KEY_F43</strong> = 307<br>
<strong>KEY_F44</strong> = 308<br>
<strong>KEY_F45</strong> = 309<br>
<strong>KEY_F46</strong> = 310<br>
<strong>KEY_F47</strong> = 311<br>
<strong>KEY_F48</strong> = 312<br>
<strong>KEY_F49</strong> = 313<br>
<strong>KEY_F5</strong> = 269<br>
<strong>KEY_F50</strong> = 314<br>
<strong>KEY_F51</strong> = 315<br>
<strong>KEY_F52</strong> = 316<br>
<strong>KEY_F53</strong> = 317<br>
<strong>KEY_F54</strong> = 318<br>
<strong>KEY_F55</strong> = 319<br>
<strong>KEY_F56</strong> = 320<br>
<strong>KEY_F57</strong> = 321<br>
<strong>KEY_F58</strong> = 322<br>
<strong>KEY_F59</strong> = 323<br>
<strong>KEY_F6</strong> = 270<br>
<strong>KEY_F60</strong> = 324<br>
<strong>KEY_F61</strong> = 325<br>
<strong>KEY_F62</strong> = 326<br>
<strong>KEY_F63</strong> = 327<br>
<strong>KEY_F7</strong> = 271<br>
<strong>KEY_F8</strong> = 272<br>
<strong>KEY_F9</strong> = 273<br>
<strong>KEY_FIND</strong> = 362<br>
<strong>KEY_HELP</strong> = 363<br>
<strong>KEY_HOME</strong> = 262<br>
<strong>KEY_IC</strong> = 331<br>
<strong>KEY_IL</strong> = 329<br>
<strong>KEY_LEFT</strong> = 260<br>
<strong>KEY_LL</strong> = 347<br>
<strong>KEY_MARK</strong> = 364<br>
<strong>KEY_MAX</strong> = 511<br>
<strong>KEY_MESSAGE</strong> = 365<br>
<strong>KEY_MIN</strong> = 257<br>
<strong>KEY_MOUSE</strong> = 409<br>
<strong>KEY_MOVE</strong> = 366<br>
<strong>KEY_NEXT</strong> = 367<br>
<strong>KEY_NPAGE</strong> = 338<br>
<strong>KEY_OPEN</strong> = 368<br>
<strong>KEY_OPTIONS</strong> = 369<br>
<strong>KEY_PPAGE</strong> = 339<br>
<strong>KEY_PREVIOUS</strong> = 370<br>
<strong>KEY_PRINT</strong> = 346<br>
<strong>KEY_REDO</strong> = 371<br>
<strong>KEY_REFERENCE</strong> = 372<br>
<strong>KEY_REFRESH</strong> = 373<br>
<strong>KEY_REPLACE</strong> = 374<br>
<strong>KEY_RESET</strong> = 345<br>
<strong>KEY_RESIZE</strong> = 410<br>
<strong>KEY_RESTART</strong> = 375<br>
<strong>KEY_RESUME</strong> = 376<br>
<strong>KEY_RIGHT</strong> = 261<br>
<strong>KEY_SAVE</strong> = 377<br>
<strong>KEY_SBEG</strong> = 378<br>
<strong>KEY_SCANCEL</strong> = 379<br>
<strong>KEY_SCOMMAND</strong> = 380<br>
<strong>KEY_SCOPY</strong> = 381<br>
<strong>KEY_SCREATE</strong> = 382<br>
<strong>KEY_SDC</strong> = 383<br>
<strong>KEY_SDL</strong> = 384<br>
<strong>KEY_SELECT</strong> = 385<br>
<strong>KEY_SEND</strong> = 386<br>
<strong>KEY_SEOL</strong> = 387<br>
<strong>KEY_SEXIT</strong> = 388<br>
<strong>KEY_SF</strong> = 336<br>
<strong>KEY_SFIND</strong> = 389<br>
<strong>KEY_SHELP</strong> = 390<br>
<strong>KEY_SHOME</strong> = 391<br>
<strong>KEY_SIC</strong> = 392<br>
<strong>KEY_SLEFT</strong> = 393<br>
<strong>KEY_SMESSAGE</strong> = 394<br>
<strong>KEY_SMOVE</strong> = 395<br>
<strong>KEY_SNEXT</strong> = 396<br>
<strong>KEY_SOPTIONS</strong> = 397<br>
<strong>KEY_SPREVIOUS</strong> = 398<br>
<strong>KEY_SPRINT</strong> = 399<br>
<strong>KEY_SR</strong> = 337<br>
<strong>KEY_SREDO</strong> = 400<br>
<strong>KEY_SREPLACE</strong> = 401<br>
<strong>KEY_SRESET</strong> = 344<br>
<strong>KEY_SRIGHT</strong> = 402<br>
<strong>KEY_SRSUME</strong> = 403<br>
<strong>KEY_SSAVE</strong> = 404<br>
<strong>KEY_SSUSPEND</strong> = 405<br>
<strong>KEY_STAB</strong> = 340<br>
<strong>KEY_SUNDO</strong> = 406<br>
<strong>KEY_SUSPEND</strong> = 407<br>
<strong>KEY_UNDO</strong> = 408<br>
<strong>KEY_UP</strong> = 259<br>
<strong>OK</strong> = 0<br>
<strong>REPORT_MOUSE_POSITION</strong> = 134217728<br>
<strong>__revision__</strong> = '$Id: __init__.py 61083 2008-02-26 08:18:30Z christian.heimes $'<br>
<strong>version</strong> = b'2.2'</td></tr></table>
</body></html>