blob: 6027067208cf8b8eed44e57e9dbd109af523898c [file] [log] [blame]
Guido van Rossum1e8c8a21997-07-19 20:02:36 +00001# tk common colour chooser dialogue
2#
3# this module provides an interface to the native color dialogue
4# available in Tk 4.2 and newer.
5#
6# written by Fredrik Lundh, May 1997
7#
Guido van Rossum5ff17611998-08-07 14:55:21 +00008# fixed initialcolor handling in August 1998
9#
Guido van Rossum1e8c8a21997-07-19 20:02:36 +000010
11#
12# options (all have default values):
13#
14# - initialcolor: colour to mark as selected when dialog is displayed
15# (given as an RGB triplet or a Tk color string)
16#
17# - parent: which window to place the dialog on top of
18#
19# - title: dialog title
20#
21
Georg Brandl14fc4272008-05-17 18:39:55 +000022from tkinter.commondialog import Dialog
Guido van Rossum1e8c8a21997-07-19 20:02:36 +000023
24
25#
26# color chooser class
27
28class Chooser(Dialog):
29 "Ask for a color"
30
31 command = "tk_chooseColor"
32
33 def _fixoptions(self):
34 try:
35 # make sure initialcolor is a tk color string
36 color = self.options["initialcolor"]
Martin v. Löwis1f1620e2008-12-29 16:27:13 +000037 if isinstance(color, tuple):
Guido van Rossum1e8c8a21997-07-19 20:02:36 +000038 # assume an RGB triplet
Guido van Rossum5ff17611998-08-07 14:55:21 +000039 self.options["initialcolor"] = "#%02x%02x%02x" % color
Guido van Rossum1e8c8a21997-07-19 20:02:36 +000040 except KeyError:
41 pass
42
43 def _fixresult(self, widget, result):
Martin v. Löwis1f1620e2008-12-29 16:27:13 +000044 # result can be somethings: an empty tuple, an empty string or
45 # a Tcl_Obj, so this somewhat weird check handles that
46 if not result or not str(result):
47 return None, None # canceled
48
Guido van Rossum1e8c8a21997-07-19 20:02:36 +000049 # to simplify application code, the color chooser returns
50 # an RGB tuple together with the Tk color string
Guido van Rossum1e8c8a21997-07-19 20:02:36 +000051 r, g, b = widget.winfo_rgb(result)
Martin v. Löwis1f1620e2008-12-29 16:27:13 +000052 return (r/256, g/256, b/256), str(result)
Guido van Rossum1e8c8a21997-07-19 20:02:36 +000053
54
55#
56# convenience stuff
57
58def askcolor(color = None, **options):
59 "Ask for a color"
60
Guido van Rossum5ff17611998-08-07 14:55:21 +000061 if color:
Guido van Rossum2b427c71998-08-10 20:13:17 +000062 options = options.copy()
63 options["initialcolor"] = color
Guido van Rossum5ff17611998-08-07 14:55:21 +000064
Raymond Hettingerff41c482003-04-06 09:01:11 +000065 return Chooser(**options).show()
Guido van Rossum1e8c8a21997-07-19 20:02:36 +000066
67
68# --------------------------------------------------------------------
69# test stuff
70
71if __name__ == "__main__":
Guido van Rossumbe19ed72007-02-09 05:37:30 +000072 print("color", askcolor())