annotate Tools/pynche/README @ 54294:dba767bc3155 legacy-trunk

remove mention of old ctypes version
author Benjamin Peterson <benjamin@python.org>
date Sat, 23 May 2009 20:59:09 +0000
parents 4adbd331d335
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9265
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
1 Pynche - The PYthonically Natural Color and Hue Editor
9581
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
2
9637
f5e586b5f790 A start on the TestModExp applet
Barry Warsaw <barry@python.org>
parents: 9581
diff changeset
3 Contact: Barry A. Warsaw
9581
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
4 Email: bwarsaw@python.org
19448
25d2f6483384 Bump to version 1.3. Also document the new behavior of the chip widgets.
Barry Warsaw <barry@python.org>
parents: 18454
diff changeset
5 Version: 1.3
9265
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
6
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
7 Introduction
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
8
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
9 Pynche is a color editor based largely on a similar program that I
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
10 originally wrote back in 1987 for the Sunview window system. That
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
11 editor was called ICE, the Interactive Color Editor. I'd always
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
12 wanted to port this program to X but didn't feel like hacking X
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
13 and C code to do it. Fast forward many years, to where Python +
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
14 Tkinter provides such a nice programming environment, with enough
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
15 power, that I finally buckled down and re-implemented it. I
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
16 changed the name because these days, too many other systems have
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
17 the acronym `ICE'.
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
18
19448
25d2f6483384 Bump to version 1.3. Also document the new behavior of the chip widgets.
Barry Warsaw <barry@python.org>
parents: 18454
diff changeset
19 Pynche should work with any variant of Python after 1.5.2
25d2f6483384 Bump to version 1.3. Also document the new behavior of the chip widgets.
Barry Warsaw <barry@python.org>
parents: 18454
diff changeset
20 (e.g. 2.0.1 and 2.1.1), using Tk 8.0.x. It's been tested on
25d2f6483384 Bump to version 1.3. Also document the new behavior of the chip widgets.
Barry Warsaw <barry@python.org>
parents: 18454
diff changeset
21 Solaris 2.6, Windows NT 4, and various Linux distros. You'll want
25d2f6483384 Bump to version 1.3. Also document the new behavior of the chip widgets.
Barry Warsaw <barry@python.org>
parents: 18454
diff changeset
22 to be sure to have at least Tk 8.0.3 for Windows. Also, Pynche is
25d2f6483384 Bump to version 1.3. Also document the new behavior of the chip widgets.
Barry Warsaw <barry@python.org>
parents: 18454
diff changeset
23 very colormap intensive, so it doesn't work very well on 8-bit
25d2f6483384 Bump to version 1.3. Also document the new behavior of the chip widgets.
Barry Warsaw <barry@python.org>
parents: 18454
diff changeset
24 graphics cards; 24bit+ graphics cards are so cheap these days,
25d2f6483384 Bump to version 1.3. Also document the new behavior of the chip widgets.
Barry Warsaw <barry@python.org>
parents: 18454
diff changeset
25 I'll probably never "fix" that.
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
26
10750
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
27 Pynche must find a text database of colors names in order to
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
28 provide `nearest' color matching. Pynche is distributed with an
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
29 rgb.txt file from the X11R6.4 distribution for this reason, along
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
30 with other "Web related" database (see below). You can use a
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
31 different file with the -d option. The file xlicense.txt contains
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
32 the license only for rgb.txt and both files are in the X/
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
33 subdirectory.
9265
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
34
18454
fee5b5717dbb Updated documentation, and bump the version number to 1.2.
Barry Warsaw <barry@python.org>
parents: 17564
diff changeset
35 Pynche is pronounced: Pin'-chee
fee5b5717dbb Updated documentation, and bump the version number to 1.2.
Barry Warsaw <barry@python.org>
parents: 17564
diff changeset
36
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
37
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
38 Running Standalone
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
39
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
40 On Unix, start it by running the `pynche' script. On Windows, run
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
41 pynche.pyw to inhibit the console window. When run from the
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
42 command line, the following options are recognized:
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
43
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
44 --database file
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
45 -d file
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
46 Alternate location of the color database file. Without this
10750
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
47 option, the first valid file found will be used (see below).
9265
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
48
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
49 --initfile file
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
50 -i file
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
51 Alternate location of the persistent initialization file. See
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
52 the section on Persistency below.
9265
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
53
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
54 --ignore
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
55 -X
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
56 Ignore the persistent initialization file when starting up.
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
57 Pynche will still write the current option settings to the
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
58 persistent init file when it quits.
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
59
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
60 --help
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
61 -h
9581
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
62 Print the help message.
9265
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
63
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
64 initialcolor
9581
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
65 a Tk color name or #rrggbb color spec to be used as the
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
66 initially selected color. This overrides any color saved in
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
67 the persistent init file. Since `#' needs to be escaped in
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
68 many shells, it is optional in the spec (e.g. #45dd1f is the
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
69 same as 45dd1f).
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
70
18454
fee5b5717dbb Updated documentation, and bump the version number to 1.2.
Barry Warsaw <barry@python.org>
parents: 17564
diff changeset
71
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
72 Running as a Modal Dialog
9265
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
73
10750
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
74 Pynche can be run as a modal dialog, inside another application,
18454
fee5b5717dbb Updated documentation, and bump the version number to 1.2.
Barry Warsaw <barry@python.org>
parents: 17564
diff changeset
75 say as a general color chooser. In fact, Grail 0.6 uses Pynche
fee5b5717dbb Updated documentation, and bump the version number to 1.2.
Barry Warsaw <barry@python.org>
parents: 17564
diff changeset
76 and a future version of IDLE may as well. Pynche supports the API
fee5b5717dbb Updated documentation, and bump the version number to 1.2.
Barry Warsaw <barry@python.org>
parents: 17564
diff changeset
77 implemented by the Tkinter standard tkColorChooser module, with a
fee5b5717dbb Updated documentation, and bump the version number to 1.2.
Barry Warsaw <barry@python.org>
parents: 17564
diff changeset
78 few changes as described below. By importing pyColorChooser from
fee5b5717dbb Updated documentation, and bump the version number to 1.2.
Barry Warsaw <barry@python.org>
parents: 17564
diff changeset
79 the Pynche package, you can run
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
80
9438
ceb878796108 Brief update on the slightly changed API of pyColorChooser.askcolor().
Barry Warsaw <barry@python.org>
parents: 9429
diff changeset
81 pyColorChooser.askcolor()
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
82
9438
ceb878796108 Brief update on the slightly changed API of pyColorChooser.askcolor().
Barry Warsaw <barry@python.org>
parents: 9429
diff changeset
83 which will popup Pynche as a modal dialog, and return the selected
ceb878796108 Brief update on the slightly changed API of pyColorChooser.askcolor().
Barry Warsaw <barry@python.org>
parents: 9429
diff changeset
84 color.
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
85
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
86 There are some UI differences when running as a modal
10750
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
87 vs. standalone. When running as a modal, there is no "Quit" menu
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
88 item under the "File" menu. Instead there are "Okay" and "Cancel"
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
89 buttons.
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
90
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
91 When "Okay" is hit, askcolor() returns the tuple
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
92
9581
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
93 ((r, g, b), "name")
9265
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
94
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
95 where r, g, and b are red, green, and blue color values
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
96 respectively (in the range 0 to 255). "name" will be a color name
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
97 from the color database if there is an exact match, otherwise it
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
98 will be an X11 color spec of the form "#rrggbb". Note that this
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
99 is different than tkColorChooser, which doesn't know anything
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
100 about color names.
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
101
9438
ceb878796108 Brief update on the slightly changed API of pyColorChooser.askcolor().
Barry Warsaw <barry@python.org>
parents: 9429
diff changeset
102 askcolor() supports the following optional keyword arguments:
ceb878796108 Brief update on the slightly changed API of pyColorChooser.askcolor().
Barry Warsaw <barry@python.org>
parents: 9429
diff changeset
103
9581
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
104 color
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
105 the color to set as the initial selected color
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
106
9581
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
107 master[*]
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
108 the master window to use as the parent of the modal
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
109 dialog. Without this argument, pyColorChooser will create
35276
4adbd331d335 Fix all wrong instances of "it's".
Georg Brandl <georg@python.org>
parents: 19448
diff changeset
110 its own Tkinter.Tk instance as the master. This may not
9581
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
111 be what you want.
9265
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
112
10763
150ac0d70929 Document that for askcolor(), databasefile and wantspec can now be set
Barry Warsaw <barry@python.org>
parents: 10753
diff changeset
113 databasefile
9581
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
114 similar to the --database option, the value must be a
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
115 file name
9265
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
116
9581
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
117 initfile[*]
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
118 similar to the --initfile option, the value must be a
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
119 file name
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
120
9581
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
121 ignore[*]
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
122 similar to the --ignore flag, the value is a boolean
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
123
10763
150ac0d70929 Document that for askcolor(), databasefile and wantspec can now be set
Barry Warsaw <barry@python.org>
parents: 10753
diff changeset
124 wantspec
9581
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
125 When this is true, the "name" field in the return tuple
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
126 will always be a color spec of the form "#rrggbb". It
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
127 will not return a color name even if there is a match;
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
128 this is so pyColorChooser can exactly match the API of
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
129 tkColorChooser.
9438
ceb878796108 Brief update on the slightly changed API of pyColorChooser.askcolor().
Barry Warsaw <barry@python.org>
parents: 9429
diff changeset
130
9581
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
131 [*] these arguments must be specified the first time
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
132 askcolor() is used and cannot be changed on subsequent calls.
9438
ceb878796108 Brief update on the slightly changed API of pyColorChooser.askcolor().
Barry Warsaw <barry@python.org>
parents: 9429
diff changeset
133
18454
fee5b5717dbb Updated documentation, and bump the version number to 1.2.
Barry Warsaw <barry@python.org>
parents: 17564
diff changeset
134
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
135 The Colorstrip Window
9265
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
136
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
137 The top part of the main Pynche window contains the "variation
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
138 strips". Each strip contains a number of "color chips". The
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
139 strips always indicate the currently selected color by a highlight
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
140 rectangle around the selected color chip, with an arrow pointing
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
141 to the chip. Each arrow has an associated number giving you the
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
142 color value along the variation's axis. Each variation strip
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
143 shows you the colors that are reachable from the selected color by
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
144 varying just one axis of the color solid.
9265
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
145
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
146 For example, when the selected color is (in Red/Green/Blue
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
147 notation) 127/127/127, the Red Variations strip shows you every
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
148 color in the range 0/127/127 to 255/127/127. Similarly for the
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
149 green and blue axes. You can select any color by clicking on its
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
150 chip. This will update the highlight rectangle and the arrow, as
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
151 well as other displays in Pynche.
9265
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
152
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
153 Click on "Update while dragging" if you want Pynche to update the
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
154 selected color while you drag along any variation strip (this will
18454
fee5b5717dbb Updated documentation, and bump the version number to 1.2.
Barry Warsaw <barry@python.org>
parents: 17564
diff changeset
155 be a bit slower). Click on "Hexadecimal" to display the arrow
fee5b5717dbb Updated documentation, and bump the version number to 1.2.
Barry Warsaw <barry@python.org>
parents: 17564
diff changeset
156 numbers in hex.
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
157
10750
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
158 There are also two shortcut buttons in this window, which
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
159 auto-select Black (0/0/0) and White (255/255/255).
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
160
18454
fee5b5717dbb Updated documentation, and bump the version number to 1.2.
Barry Warsaw <barry@python.org>
parents: 17564
diff changeset
161
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
162 The Proof Window
9265
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
163
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
164 In the lower left corner of the main window you see two larger
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
165 color chips. The Selected chip shows you a larger version of the
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
166 color selected in the variation strips, along with its X11 color
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
167 specification. The Nearest chip shows you the closest color in
19448
25d2f6483384 Bump to version 1.3. Also document the new behavior of the chip widgets.
Barry Warsaw <barry@python.org>
parents: 18454
diff changeset
168 the X11 database to the selected color, giving its X11 color
25d2f6483384 Bump to version 1.3. Also document the new behavior of the chip widgets.
Barry Warsaw <barry@python.org>
parents: 18454
diff changeset
169 specification, and below that, its X11 color name. When the
25d2f6483384 Bump to version 1.3. Also document the new behavior of the chip widgets.
Barry Warsaw <barry@python.org>
parents: 18454
diff changeset
170 Selected chip color exactly matches the Nearest chip color, you
25d2f6483384 Bump to version 1.3. Also document the new behavior of the chip widgets.
Barry Warsaw <barry@python.org>
parents: 18454
diff changeset
171 will see the color name appear below the color specification for
25d2f6483384 Bump to version 1.3. Also document the new behavior of the chip widgets.
Barry Warsaw <barry@python.org>
parents: 18454
diff changeset
172 the Selected chip.
25d2f6483384 Bump to version 1.3. Also document the new behavior of the chip widgets.
Barry Warsaw <barry@python.org>
parents: 18454
diff changeset
173
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
174 Clicking on the Nearest color chip selects that color. Color
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
175 distance is calculated in the 3D space of the RGB color solid and
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
176 if more than one color name is the same distance from the selected
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
177 color, the first one found will be chosen.
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
178
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
179 Note that there may be more than one X11 color name for the same
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
180 RGB value. In that case, the first one found in the text database
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
181 is designated the "primary" name, and this is shown under the
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
182 Nearest chip. The other names are "aliases" and they are visible
10750
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
183 in the Color List Window (see below).
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
184
19448
25d2f6483384 Bump to version 1.3. Also document the new behavior of the chip widgets.
Barry Warsaw <barry@python.org>
parents: 18454
diff changeset
185 Both the color specifications and color names are selectable for
25d2f6483384 Bump to version 1.3. Also document the new behavior of the chip widgets.
Barry Warsaw <barry@python.org>
parents: 18454
diff changeset
186 copying and pasting into another window.
25d2f6483384 Bump to version 1.3. Also document the new behavior of the chip widgets.
Barry Warsaw <barry@python.org>
parents: 18454
diff changeset
187
18454
fee5b5717dbb Updated documentation, and bump the version number to 1.2.
Barry Warsaw <barry@python.org>
parents: 17564
diff changeset
188
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
189 The Type-in Window
9265
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
190
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
191 At the lower right of the main window are three entry fields.
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
192 Here you can type numeric values for any of the three color axes.
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
193 Legal values are between 0 and 255, and these fields do not allow
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
194 you to enter illegal values. You must hit Enter or Tab to select
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
195 the new color.
9265
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
196
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
197 Click on "Update while typing" if you want Pynche to select the
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
198 color on every keystroke (well, every one that produces a legal
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
199 value!) Click on "Hexadecimal" to display and enter color values
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
200 in hex.
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
201
18454
fee5b5717dbb Updated documentation, and bump the version number to 1.2.
Barry Warsaw <barry@python.org>
parents: 17564
diff changeset
202
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
203 Other Views
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
204
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
205 There are three secondary windows which are not displayed by
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
206 default. You can bring these up via the "View" menu on the main
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
207 Pynche window.
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
208
18454
fee5b5717dbb Updated documentation, and bump the version number to 1.2.
Barry Warsaw <barry@python.org>
parents: 17564
diff changeset
209
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
210 The Text Window
9265
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
211
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
212 The "Text Window" allows you to see what effects various colors
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
213 have on the standard Tk text widget elements. In the upper part
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
214 of the window is a plain Tk text widget and here you can edit the
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
215 text, select a region of text, etc. Below this is a button "Track
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
216 color changes". When this is turned on, any colors selected in
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
217 the other windows will change the text widget element specified in
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
218 the radio buttons below. When this is turned off, text widget
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
219 elements are not affected by color selection.
9265
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
220
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
221 You can choose which element gets changed by color selection by
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
222 clicking on one of the radio buttons in the bottom part of this
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
223 window. Text foreground and background affect the text in the
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
224 upper part of the window. Selection foreground and background
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
225 affect the colors of the primary selection which is what you see
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
226 when you click the middle button (depending on window system) and
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
227 drag it through some text.
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
228
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
229 The Insertion is the insertion cursor in the text window, where
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
230 new text will be inserted as you type. The insertion cursor only
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
231 has a background.
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
232
18454
fee5b5717dbb Updated documentation, and bump the version number to 1.2.
Barry Warsaw <barry@python.org>
parents: 17564
diff changeset
233
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
234 The Color List Window
9265
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
235
10750
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
236 The "Color List" window shows every named color in the color name
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
237 database (this window may take a while to come up). In the upper
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
238 part of the window you see a scrolling list of all the color names
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
239 in the database, in alphabetical order. Click on any color to
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
240 select it. In the bottom part of the window is displayed any
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
241 aliases for the selected color (those color names that have the
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
242 same RGB value, but were found later in the text database). For
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
243 example, find the color "Black" and you'll see that its aliases
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
244 are "gray0" and "grey0".
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
245
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
246 If the color has no aliases you'll see "<no aliases>" here. If you
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
247 just want to see if a color has an alias, and do not want to select a
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
248 color when you click on it, turn off "Update on Click".
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
249
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
250 Note that the color list is always updated when a color is selected
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
251 from the main window. There's no way to turn this feature off. If
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
252 the selected color has no matching color name you'll see
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
253 "<no matching color>" in the Aliases window.
9265
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
254
18454
fee5b5717dbb Updated documentation, and bump the version number to 1.2.
Barry Warsaw <barry@python.org>
parents: 17564
diff changeset
255
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
256 The Details Window
9265
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
257
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
258 The "Details" window gives you more control over color selection
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
259 than just clicking on a color chip in the main window. The row of
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
260 buttons along the top apply the specified increment and decrement
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
261 amounts to the selected color. These delta amounts are applied to
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
262 the variation strips specified by the check boxes labeled "Move
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
263 Sliders". Thus if just Red and Green are selected, hitting -10
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
264 will subtract 10 from the color value along the red and green
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
265 variation only. Note the message under the checkboxes; this
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
266 indicates the primary color level being changed when more than one
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
267 slider is tied together. For example, if Red and Green are
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
268 selected, you will be changing the Yellow level of the selected
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
269 color.
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
270
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
271 The "At Boundary" behavior determines what happens when any color
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
272 variation hits either the lower or upper boundaries (0 or 255) as
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
273 a result of clicking on the top row buttons:
9265
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
274
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
275 Stop
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
276 When the increment or decrement would send any of the tied
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
277 variations out of bounds, the entire delta is discarded.
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
278
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
279 Wrap Around
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
280 When the increment or decrement would send any of the tied
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
281 variations out of bounds, the out of bounds value is wrapped
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
282 around to the other side. Thus if red were at 238 and +25
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
283 were clicked, red would have the value 7.
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
284
10750
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
285 Preserve Distance
9265
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
286 When the increment or decrement would send any of the tied
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
287 variations out of bounds, all tied variations are wrapped as
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
288 one, so as to preserve the distance between them. Thus if
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
289 green and blue were tied, and green was at 238 while blue was
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
290 at 223, and +25 were clicked, green would be at 15 and blue
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
291 would be at 0.
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
292
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
293 Squash
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
294 When the increment or decrement would send any of the tied
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
295 variations out of bounds, the out of bounds variation is set
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
296 to the ceiling of 255 or floor of 0, as appropriate. In this
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
297 way, all tied variations are squashed to one edge or the
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
298 other.
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
299
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
300 The top row buttons have the following keyboard accelerators:
9265
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
301
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
302 -25 == Shift Left Arrow
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
303 -10 == Control Left Arrow
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
304 -1 == Left Arrow
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
305 +1 == Right Arrow
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
306 +10 == Control Right Arrow
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
307 +25 == Shift Right Arrow
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
308
18454
fee5b5717dbb Updated documentation, and bump the version number to 1.2.
Barry Warsaw <barry@python.org>
parents: 17564
diff changeset
309
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
310 Keyboard Accelerators
9265
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
311
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
312 Alt-w in any secondary window dismisses the window. In the main
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
313 window it exits Pynche (except when running as a modal).
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
314
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
315 Alt-q in any window exits Pynche (except when running as a modal).
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
316
18454
fee5b5717dbb Updated documentation, and bump the version number to 1.2.
Barry Warsaw <barry@python.org>
parents: 17564
diff changeset
317
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
318 Persistency
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
319
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
320 Pynche remembers various settings of options and colors between
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
321 invocations, storing these values in a `persistent initialization
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
322 file'. The actual location of this file is specified by the
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
323 --initfile option (see above), and defaults to ~/.pynche.
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
324
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
325 When Pynche exits, it saves these values in the init file, and
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
326 re-reads them when it starts up. There is no locking on this
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
327 file, so if you run multiple instances of Pynche at a time, you
10750
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
328 may clobber the init file.
9265
c116bb3e2ad1 A readme
Barry Warsaw <barry@python.org>
parents:
diff changeset
329
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
330 The actual options stored include
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
331
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
332 - the currently selected color
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
333
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
334 - all settings of checkbox and radio button options in all windows
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
335
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
336 - the contents of the text window, the current text selection and
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
337 insertion point, and all current text widget element color
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
338 settings.
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
339
10750
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
340 - the name of the color database file (but not its contents)
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
341
9429
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
342 You can inhibit Pynche from reading the init file by supplying the
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
343 --ignore option on the command line. However, you cannot suppress
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
344 the storing of the settings in the init file on Pynche exit. If
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
345 you really want to do this, use /dev/null as the init file, using
337ae12d8050 Describe all the new features
Barry Warsaw <barry@python.org>
parents: 9389
diff changeset
346 --initfile.
9438
ceb878796108 Brief update on the slightly changed API of pyColorChooser.askcolor().
Barry Warsaw <barry@python.org>
parents: 9429
diff changeset
347
18454
fee5b5717dbb Updated documentation, and bump the version number to 1.2.
Barry Warsaw <barry@python.org>
parents: 17564
diff changeset
348
10750
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
349 Color Name Database Files
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
350
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
351 Pynche uses a color name database file to calculate the nearest
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
352 color to the selected color, and to display in the Color List
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
353 view. Several files are distributed with Pynche, described
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
354 below. By default, the X11 color name database file is selected.
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
355 Other files:
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
356
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
357 html40colors.txt -- the HTML 4.0 guaranteed color names
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
358
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
359 websafe.txt -- the 216 "Web-safe" colors that Netscape and MSIE
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
360 guarantee will not be dithered. These are specified in #rrggbb
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
361 format for both values and names
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
362
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
363 webcolors.txt -- The 140 color names that Tim Peters and his
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
364 sister say NS and MSIE both understand (with some controversy over
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
365 AliceBlue).
8f3665bb9e3e Describe the Color database files
Barry Warsaw <barry@python.org>
parents: 9637
diff changeset
366
10753
81f54c00e224 Describe namedcolors.txt
Barry Warsaw <barry@python.org>
parents: 10751
diff changeset
367 namedcolors.txt -- an alternative set of Netscape colors.
81f54c00e224 Describe namedcolors.txt
Barry Warsaw <barry@python.org>
parents: 10751
diff changeset
368
10751
8edbd5ab6217 Describe how to load a new database
Barry Warsaw <barry@python.org>
parents: 10750
diff changeset
369 You can switch between files by choosing "Load palette..." from
8edbd5ab6217 Describe how to load a new database
Barry Warsaw <barry@python.org>
parents: 10750
diff changeset
370 the "File" menu. This brings up a standard Tk file dialog.
8edbd5ab6217 Describe how to load a new database
Barry Warsaw <barry@python.org>
parents: 10750
diff changeset
371 Choose the file you want and then click "Ok". If Pynche
8edbd5ab6217 Describe how to load a new database
Barry Warsaw <barry@python.org>
parents: 10750
diff changeset
372 understands the format in this file, it will load the database and
8edbd5ab6217 Describe how to load a new database
Barry Warsaw <barry@python.org>
parents: 10750
diff changeset
373 update the appropriate windows. If not, it will bring up an error
8edbd5ab6217 Describe how to load a new database
Barry Warsaw <barry@python.org>
parents: 10750
diff changeset
374 dialog.
8edbd5ab6217 Describe how to load a new database
Barry Warsaw <barry@python.org>
parents: 10750
diff changeset
375
18454
fee5b5717dbb Updated documentation, and bump the version number to 1.2.
Barry Warsaw <barry@python.org>
parents: 17564
diff changeset
376
9438
ceb878796108 Brief update on the slightly changed API of pyColorChooser.askcolor().
Barry Warsaw <barry@python.org>
parents: 9429
diff changeset
377 To Do
ceb878796108 Brief update on the slightly changed API of pyColorChooser.askcolor().
Barry Warsaw <barry@python.org>
parents: 9429
diff changeset
378
18454
fee5b5717dbb Updated documentation, and bump the version number to 1.2.
Barry Warsaw <barry@python.org>
parents: 17564
diff changeset
379 Here's a brief list of things I want to do (some mythical day):
9438
ceb878796108 Brief update on the slightly changed API of pyColorChooser.askcolor().
Barry Warsaw <barry@python.org>
parents: 9429
diff changeset
380
ceb878796108 Brief update on the slightly changed API of pyColorChooser.askcolor().
Barry Warsaw <barry@python.org>
parents: 9429
diff changeset
381 - Better support for resizing the top level windows
ceb878796108 Brief update on the slightly changed API of pyColorChooser.askcolor().
Barry Warsaw <barry@python.org>
parents: 9429
diff changeset
382
ceb878796108 Brief update on the slightly changed API of pyColorChooser.askcolor().
Barry Warsaw <barry@python.org>
parents: 9429
diff changeset
383 - More output views, e.g. color solids
ceb878796108 Brief update on the slightly changed API of pyColorChooser.askcolor().
Barry Warsaw <barry@python.org>
parents: 9429
diff changeset
384
ceb878796108 Brief update on the slightly changed API of pyColorChooser.askcolor().
Barry Warsaw <barry@python.org>
parents: 9429
diff changeset
385 - Have the notion of a `last color selected'; this may require a
ceb878796108 Brief update on the slightly changed API of pyColorChooser.askcolor().
Barry Warsaw <barry@python.org>
parents: 9429
diff changeset
386 new output view
ceb878796108 Brief update on the slightly changed API of pyColorChooser.askcolor().
Barry Warsaw <barry@python.org>
parents: 9429
diff changeset
387
ceb878796108 Brief update on the slightly changed API of pyColorChooser.askcolor().
Barry Warsaw <barry@python.org>
parents: 9429
diff changeset
388 - Support setting the font in the text view
ceb878796108 Brief update on the slightly changed API of pyColorChooser.askcolor().
Barry Warsaw <barry@python.org>
parents: 9429
diff changeset
389
18454
fee5b5717dbb Updated documentation, and bump the version number to 1.2.
Barry Warsaw <barry@python.org>
parents: 17564
diff changeset
390 - Support distutils setup.py for installation
fee5b5717dbb Updated documentation, and bump the version number to 1.2.
Barry Warsaw <barry@python.org>
parents: 17564
diff changeset
391
9438
ceb878796108 Brief update on the slightly changed API of pyColorChooser.askcolor().
Barry Warsaw <barry@python.org>
parents: 9429
diff changeset
392 I'm open to suggestions!
9581
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
393
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
394
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
395
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
396 Local Variables:
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
397 indent-tabs-mode: nil
4595ef5a968a Untabification and other cruft
Barry Warsaw <barry@python.org>
parents: 9493
diff changeset
398 End: