Skip to content

Commit 11e42fd

Browse files
author
4b796c65
committed
Mostly documentation updates.
1 parent b3a2623 commit 11e42fd

File tree

14 files changed

+336
-639
lines changed

14 files changed

+336
-639
lines changed

MANIFEST.in

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
include *.txt
2-
include *.bat
32
include tdl/*.bmp
43
include tdl/*.png
54
include tdl/*.txt

README.txt

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,6 @@
1-
=== Installation ===
2-
Run the command "setup.py install"
3-
4-
Mac users will need to install the files found in the Frameworks directory
5-
61
=== Requirements ===
72
* Python 2.6+ or 3.x
8-
* 32 bit Windows, 32/64 bit Linux, or Mac OS/X (32 bit architecture)
9-
10-
Additonal Mac requirements (included in Frameworks directory):
11-
* SDL Framework: http://www.libsdl.org/release/SDL-1.2.14.dmg
12-
* libpng Framework: http://ethan.tira-thompson.org/Mac_OS_X_Ports_files/libpng%20%28universal%29.dmg
13-
Mount the .dmg's and copy the framework to /Libraries/Frameworks (you might need to run finder as root. If so, in terminal "paste sudo /System/Library/CoreServices/Finder.app/Contents/MacOS/Finder")
3+
* 32 bit Windows, 32/64 bit Linux, or Mac OS/X (64 bit architecture)
144

155
=== About ===
166
TDL is a port of the C library libtcod in an attempt to make it more "Pythonic"

documentation/tdl.event.html

Lines changed: 25 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1+
12
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
23
<html><head><title>Python: module tdl.event</title>
3-
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
44
</head><body bgcolor="#f0f0f8">
55

66
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
@@ -13,13 +13,14 @@
1313
&nbsp;<br>
1414
Here's&nbsp;a&nbsp;quick&nbsp;reference&nbsp;to&nbsp;<a href="#Event">Event</a>&nbsp;types&nbsp;and&nbsp;their&nbsp;attributes:<br>
1515
QUIT<br>
16-
KEYDOWN:&nbsp;key&nbsp;char&nbsp;alt&nbsp;ctrl&nbsp;shift&nbsp;lalt&nbsp;lctrl&nbsp;ralt&nbsp;rctrl<br>
17-
KEYUP:&nbsp;key&nbsp;char&nbsp;alt&nbsp;ctrl&nbsp;shift&nbsp;lalt&nbsp;lctrl&nbsp;ralt&nbsp;rctrl<br>
16+
KEYDOWN:&nbsp;keyname&nbsp;key&nbsp;char&nbsp;alt&nbsp;ctrl&nbsp;shift&nbsp;lalt&nbsp;lctrl&nbsp;ralt&nbsp;rctrl<br>
17+
KEYUP:&nbsp;keyname&nbsp;key&nbsp;char&nbsp;alt&nbsp;ctrl&nbsp;shift&nbsp;lalt&nbsp;lctrl&nbsp;ralt&nbsp;rctrl<br>
1818
MOUSEDOWN:&nbsp;button&nbsp;pos&nbsp;cell<br>
1919
MOUSEUP:&nbsp;button&nbsp;pos&nbsp;cell<br>
2020
MOUSEMOTION:&nbsp;pos&nbsp;cell&nbsp;motion&nbsp;cellmotion<br>
2121
&nbsp;<br>
22-
You&nbsp;will&nbsp;likely&nbsp;want&nbsp;to&nbsp;use&nbsp;the&nbsp;tdl.event.get&nbsp;function&nbsp;but&nbsp;you&nbsp;can&nbsp;still&nbsp;use&nbsp;the&nbsp;keyWait&nbsp;and&nbsp;isWindowClosed&nbsp;functions&nbsp;if&nbsp;you&nbsp;want.</tt></p>
22+
You&nbsp;will&nbsp;likely&nbsp;want&nbsp;to&nbsp;use&nbsp;the&nbsp;tdl.event.get&nbsp;function&nbsp;but&nbsp;you&nbsp;can&nbsp;still<br>
23+
use&nbsp;keyWait&nbsp;and&nbsp;isWindowClosed&nbsp;to&nbsp;control&nbsp;your&nbsp;entire&nbsp;program.</tt></p>
2324
<p>
2425
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
2526
<tr bgcolor="#aa55cc">
@@ -29,16 +30,15 @@
2930
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
3031
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="tdl.tcod.html">tdl.tcod</a><br>
3132
</td><td width="25%" valign=top><a href="ctypes.html">ctypes</a><br>
32-
</td><td width="25%" valign=top><a href="tdl.local.html">tdl.local</a><br>
33-
</td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
33+
</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
3434
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
3535
<tr bgcolor="#ee77aa">
3636
<td colspan=3 valign=bottom>&nbsp;<br>
3737
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
3838

3939
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
4040
<td width="100%"><dl>
41-
<dt><font face="helvetica, arial"><a href="builtins.html#object">builtins.object</a>
41+
<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
4242
</font></dt><dd>
4343
<dl>
4444
<dt><font face="helvetica, arial"><a href="tdl.event.html#Event">Event</a>
@@ -69,7 +69,7 @@
6969
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
7070
<tr bgcolor="#ffc8d8">
7171
<td colspan=3 valign=bottom>&nbsp;<br>
72-
<font color="#000000" face="helvetica, arial"><a name="Event">class <strong>Event</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
72+
<font color="#000000" face="helvetica, arial"><a name="Event">class <strong>Event</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
7373

7474
<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
7575
<td width="100%">Methods defined here:<br>
@@ -90,7 +90,7 @@
9090
<dd><a href="tdl.event.html#KeyDown">KeyDown</a></dd>
9191
<dd><a href="tdl.event.html#KeyEvent">KeyEvent</a></dd>
9292
<dd><a href="tdl.event.html#Event">Event</a></dd>
93-
<dd><a href="builtins.html#object">builtins.object</a></dd>
93+
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
9494
</dl>
9595
<hr>
9696
Data and other attributes defined here:<br>
@@ -136,7 +136,7 @@
136136
<td width="100%"><dl><dt>Method resolution order:</dt>
137137
<dd><a href="tdl.event.html#KeyEvent">KeyEvent</a></dd>
138138
<dd><a href="tdl.event.html#Event">Event</a></dd>
139-
<dd><a href="builtins.html#object">builtins.object</a></dd>
139+
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
140140
</dl>
141141
<hr>
142142
Methods defined here:<br>
@@ -183,7 +183,7 @@
183183
<dd><a href="tdl.event.html#KeyUp">KeyUp</a></dd>
184184
<dd><a href="tdl.event.html#KeyEvent">KeyEvent</a></dd>
185185
<dd><a href="tdl.event.html#Event">Event</a></dd>
186-
<dd><a href="builtins.html#object">builtins.object</a></dd>
186+
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
187187
</dl>
188188
<hr>
189189
Data and other attributes defined here:<br>
@@ -229,7 +229,7 @@
229229
<td width="100%"><dl><dt>Method resolution order:</dt>
230230
<dd><a href="tdl.event.html#MouseButtonEvent">MouseButtonEvent</a></dd>
231231
<dd><a href="tdl.event.html#Event">Event</a></dd>
232-
<dd><a href="builtins.html#object">builtins.object</a></dd>
232+
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
233233
</dl>
234234
<hr>
235235
Methods defined here:<br>
@@ -243,14 +243,14 @@
243243
</dl>
244244
<dl><dt><strong>pos</strong></dt>
245245
</dl>
246-
<hr>
247-
Data and other attributes defined here:<br>
248-
<dl><dt><strong>type</strong> = 'MOUSEDOWN'</dl>
249-
250246
<hr>
251247
Methods inherited from <a href="tdl.event.html#Event">Event</a>:<br>
252248
<dl><dt><a name="MouseButtonEvent-__repr__"><strong>__repr__</strong></a>(self)</dt></dl>
253249

250+
<hr>
251+
Data and other attributes inherited from <a href="tdl.event.html#Event">Event</a>:<br>
252+
<dl><dt><strong>type</strong> = None</dl>
253+
254254
</td></tr></table> <p>
255255
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
256256
<tr bgcolor="#ffc8d8">
@@ -262,7 +262,7 @@
262262
<dd><a href="tdl.event.html#MouseDown">MouseDown</a></dd>
263263
<dd><a href="tdl.event.html#MouseButtonEvent">MouseButtonEvent</a></dd>
264264
<dd><a href="tdl.event.html#Event">Event</a></dd>
265-
<dd><a href="builtins.html#object">builtins.object</a></dd>
265+
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
266266
</dl>
267267
<hr>
268268
Data and other attributes defined here:<br>
@@ -294,11 +294,11 @@
294294
<td width="100%"><dl><dt>Method resolution order:</dt>
295295
<dd><a href="tdl.event.html#MouseMotion">MouseMotion</a></dd>
296296
<dd><a href="tdl.event.html#Event">Event</a></dd>
297-
<dd><a href="builtins.html#object">builtins.object</a></dd>
297+
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
298298
</dl>
299299
<hr>
300300
Methods defined here:<br>
301-
<dl><dt><a name="MouseMotion-__init__"><strong>__init__</strong></a>(self, pos, cell, relpos, relcell)</dt></dl>
301+
<dl><dt><a name="MouseMotion-__init__"><strong>__init__</strong></a>(self, pos, cell, motion, cellmotion)</dt></dl>
302302

303303
<hr>
304304
Data descriptors defined here:<br>
@@ -310,10 +310,6 @@
310310
</dl>
311311
<dl><dt><strong>pos</strong></dt>
312312
</dl>
313-
<dl><dt><strong>relcell</strong></dt>
314-
</dl>
315-
<dl><dt><strong>relpos</strong></dt>
316-
</dl>
317313
<hr>
318314
Data and other attributes defined here:<br>
319315
<dl><dt><strong>type</strong> = 'MOUSEMOTION'</dl>
@@ -333,7 +329,7 @@
333329
<dd><a href="tdl.event.html#MouseUp">MouseUp</a></dd>
334330
<dd><a href="tdl.event.html#MouseButtonEvent">MouseButtonEvent</a></dd>
335331
<dd><a href="tdl.event.html#Event">Event</a></dd>
336-
<dd><a href="builtins.html#object">builtins.object</a></dd>
332+
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
337333
</dl>
338334
<hr>
339335
Data and other attributes defined here:<br>
@@ -365,7 +361,7 @@
365361
<td width="100%"><dl><dt>Method resolution order:</dt>
366362
<dd><a href="tdl.event.html#Quit">Quit</a></dd>
367363
<dd><a href="tdl.event.html#Event">Event</a></dd>
368-
<dd><a href="builtins.html#object">builtins.object</a></dd>
364+
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
369365
</dl>
370366
<hr>
371367
Data and other attributes defined here:<br>
@@ -395,23 +391,20 @@
395391
&nbsp;<br>
396392
Here&nbsp;is&nbsp;a&nbsp;list&nbsp;of&nbsp;events&nbsp;and&nbsp;their&nbsp;attributes:<br>
397393
QUIT<br>
398-
KEYDOWN:&nbsp;key&nbsp;char&nbsp;alt&nbsp;ctrl&nbsp;shift&nbsp;lalt&nbsp;lctrl&nbsp;ralt&nbsp;rctrl<br>
399-
KEYUP:&nbsp;key&nbsp;char&nbsp;alt&nbsp;ctrl&nbsp;shift&nbsp;lalt&nbsp;lctrl&nbsp;ralt&nbsp;rctrl<br>
394+
KEYDOWN:&nbsp;key&nbsp;char&nbsp;keyname&nbsp;alt&nbsp;ctrl&nbsp;shift&nbsp;lalt&nbsp;lctrl&nbsp;ralt&nbsp;rctrl<br>
395+
KEYUP:&nbsp;key&nbsp;char&nbsp;keyname&nbsp;alt&nbsp;ctrl&nbsp;shift&nbsp;lalt&nbsp;lctrl&nbsp;ralt&nbsp;rctrl<br>
400396
MOUSEDOWN:&nbsp;button&nbsp;pos&nbsp;cell<br>
401397
MOUSEUP:&nbsp;button&nbsp;pos&nbsp;cell<br>
402398
MOUSEMOTION:&nbsp;pos&nbsp;motion&nbsp;cell&nbsp;cellmotion</tt></dd></dl>
403399
<dl><dt><a name="-isWindowClosed"><strong>isWindowClosed</strong></a>()</dt><dd><tt>Returns&nbsp;True&nbsp;if&nbsp;the&nbsp;exit&nbsp;button&nbsp;on&nbsp;the&nbsp;window&nbsp;has&nbsp;been&nbsp;clicked&nbsp;and<br>
404400
stays&nbsp;True&nbsp;afterwards.</tt></dd></dl>
405-
<dl><dt><a name="-keyPressed"><strong>keyPressed</strong></a>(key)</dt><dd><tt>Returns&nbsp;True&nbsp;when&nbsp;key&nbsp;is&nbsp;currently&nbsp;pressed.<br>
406-
&nbsp;<br>
407-
key&nbsp;can&nbsp;be&nbsp;a&nbsp;number&nbsp;or&nbsp;single&nbsp;length&nbsp;string</tt></dd></dl>
408-
<dl><dt><a name="-keyWait"><strong>keyWait</strong></a>()</dt><dd><tt>Waits&nbsp;until&nbsp;the&nbsp;user&nbsp;presses&nbsp;a&nbsp;key.&nbsp;&nbsp;Returns&nbsp;<a href="#KeyDown">KeyDown</a>&nbsp;events.</tt></dd></dl>
401+
<dl><dt><a name="-keyWait"><strong>keyWait</strong></a>()</dt><dd><tt>Waits&nbsp;until&nbsp;the&nbsp;user&nbsp;presses&nbsp;a&nbsp;key.&nbsp;&nbsp;Then&nbsp;returns&nbsp;a&nbsp;<a href="#KeyDown">KeyDown</a>&nbsp;event.</tt></dd></dl>
409402
</td></tr></table><p>
410403
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
411404
<tr bgcolor="#55aa55">
412405
<td colspan=3 valign=bottom>&nbsp;<br>
413406
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
414407

415408
<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
416-
<td width="100%"><strong>__all__</strong> = ['Quit', 'MouseUp', 'KeyDown', 'keyWait', 'MouseMotion', 'keyPressed', 'MouseButtonEvent', 'local', 'isWindowClosed', 'get', 'ctypes', 'KeyEvent', 'KeyUp', 'MouseDown', 'Event']</td></tr></table>
409+
<td width="100%"><strong>__all__</strong> = ['Quit', 'MouseUp', 'KeyDown', 'keyWait', 'MouseMotion', 'MouseButtonEvent', 'isWindowClosed', 'get', 'MouseDown', 'KeyEvent', 'KeyUp', 'ctypes', 'Event']</td></tr></table>
417410
</body></html>

0 commit comments

Comments
 (0)