Fredrik Lundh | d489398 | 2005-11-12 15:28:52 +0000 | [diff] [blame] | 1 | # Tkinter font wrapper |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 2 | # |
Fredrik Lundh | d489398 | 2005-11-12 15:28:52 +0000 | [diff] [blame] | 3 | # written by Fredrik Lundh, February 1998 |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 4 | # |
| 5 | # FIXME: should add 'displayof' option where relevant (actual, families, |
| 6 | # measure, and metrics) |
Fred Drake | d038ca8 | 2000-10-23 18:31:14 +0000 | [diff] [blame] | 7 | # |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 8 | |
| 9 | __version__ = "0.9" |
| 10 | |
Georg Brandl | 14fc427 | 2008-05-17 18:39:55 +0000 | [diff] [blame] | 11 | import tkinter |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 12 | |
Andrew Svetlov | 5af3e1a | 2012-04-03 09:39:47 +0300 | [diff] [blame^] | 13 | |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 14 | # weight/slant |
| 15 | NORMAL = "normal" |
Martin v. Löwis | 1ef2365 | 2003-06-14 21:40:04 +0000 | [diff] [blame] | 16 | ROMAN = "roman" |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 17 | BOLD = "bold" |
| 18 | ITALIC = "italic" |
| 19 | |
Andrew Svetlov | 5af3e1a | 2012-04-03 09:39:47 +0300 | [diff] [blame^] | 20 | |
Martin v. Löwis | fe84d17 | 2004-08-18 11:06:45 +0000 | [diff] [blame] | 21 | def nametofont(name): |
| 22 | """Given the name of a tk named font, returns a Font representation. |
| 23 | """ |
| 24 | return Font(name=name, exists=True) |
Tim Peters | a45cacf | 2004-08-20 03:47:14 +0000 | [diff] [blame] | 25 | |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 26 | |
Andrew Svetlov | 5af3e1a | 2012-04-03 09:39:47 +0300 | [diff] [blame^] | 27 | class Font: |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 28 | """Represents a named font. |
| 29 | |
| 30 | Constructor options are: |
| 31 | |
| 32 | font -- font specifier (name, system font, or (family, size, style)-tuple) |
Martin v. Löwis | fe84d17 | 2004-08-18 11:06:45 +0000 | [diff] [blame] | 33 | name -- name to use for this font configuration (defaults to a unique name) |
| 34 | exists -- does a named font by this name already exist? |
| 35 | Creates a new named font if False, points to the existing font if True. |
| 36 | Raises _tkinter.TclError if the assertion is false. |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 37 | |
Martin v. Löwis | fe84d17 | 2004-08-18 11:06:45 +0000 | [diff] [blame] | 38 | the following are ignored if font is specified: |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 39 | |
| 40 | family -- font 'family', e.g. Courier, Times, Helvetica |
| 41 | size -- font size in points |
| 42 | weight -- font thickness: NORMAL, BOLD |
Martin v. Löwis | 1ef2365 | 2003-06-14 21:40:04 +0000 | [diff] [blame] | 43 | slant -- font slant: ROMAN, ITALIC |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 44 | underline -- font underlining: false (0), true (1) |
| 45 | overstrike -- font strikeout: false (0), true (1) |
Tim Peters | a45cacf | 2004-08-20 03:47:14 +0000 | [diff] [blame] | 46 | |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 47 | """ |
| 48 | |
| 49 | def _set(self, kw): |
| 50 | options = [] |
| 51 | for k, v in kw.items(): |
| 52 | options.append("-"+k) |
| 53 | options.append(str(v)) |
| 54 | return tuple(options) |
| 55 | |
| 56 | def _get(self, args): |
Fred Drake | d038ca8 | 2000-10-23 18:31:14 +0000 | [diff] [blame] | 57 | options = [] |
| 58 | for k in args: |
| 59 | options.append("-"+k) |
| 60 | return tuple(options) |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 61 | |
| 62 | def _mkdict(self, args): |
| 63 | options = {} |
| 64 | for i in range(0, len(args), 2): |
| 65 | options[args[i][1:]] = args[i+1] |
| 66 | return options |
| 67 | |
Andrew Svetlov | 5af3e1a | 2012-04-03 09:39:47 +0300 | [diff] [blame^] | 68 | def __init__(self, root=None, font=None, name=None, exists=False, |
| 69 | **options): |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 70 | if not root: |
Georg Brandl | 14fc427 | 2008-05-17 18:39:55 +0000 | [diff] [blame] | 71 | root = tkinter._default_root |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 72 | if font: |
| 73 | # get actual settings corresponding to the given font |
| 74 | font = root.tk.splitlist(root.tk.call("font", "actual", font)) |
| 75 | else: |
| 76 | font = self._set(options) |
| 77 | if not name: |
| 78 | name = "font" + str(id(self)) |
| 79 | self.name = name |
Martin v. Löwis | fe84d17 | 2004-08-18 11:06:45 +0000 | [diff] [blame] | 80 | |
| 81 | if exists: |
| 82 | self.delete_font = False |
| 83 | # confirm font exists |
| 84 | if self.name not in root.tk.call("font", "names"): |
Georg Brandl | 14fc427 | 2008-05-17 18:39:55 +0000 | [diff] [blame] | 85 | raise tkinter._tkinter.TclError( |
| 86 | "named font %s does not already exist" % (self.name,)) |
Martin v. Löwis | fe84d17 | 2004-08-18 11:06:45 +0000 | [diff] [blame] | 87 | # if font config info supplied, apply it |
| 88 | if font: |
Martin v. Löwis | fe84d17 | 2004-08-18 11:06:45 +0000 | [diff] [blame] | 89 | root.tk.call("font", "configure", self.name, *font) |
| 90 | else: |
| 91 | # create new font (raises TclError if the font exists) |
Tim Peters | a45cacf | 2004-08-20 03:47:14 +0000 | [diff] [blame] | 92 | root.tk.call("font", "create", self.name, *font) |
Martin v. Löwis | fe84d17 | 2004-08-18 11:06:45 +0000 | [diff] [blame] | 93 | self.delete_font = True |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 94 | # backlinks! |
| 95 | self._root = root |
| 96 | self._split = root.tk.splitlist |
| 97 | self._call = root.tk.call |
| 98 | |
| 99 | def __str__(self): |
| 100 | return self.name |
| 101 | |
Martin v. Löwis | fe84d17 | 2004-08-18 11:06:45 +0000 | [diff] [blame] | 102 | def __eq__(self, other): |
Amaury Forgeot d'Arc | d61d077 | 2010-09-17 23:27:09 +0000 | [diff] [blame] | 103 | return isinstance(other, Font) and self.name == other.name |
Martin v. Löwis | fe84d17 | 2004-08-18 11:06:45 +0000 | [diff] [blame] | 104 | |
| 105 | def __getitem__(self, key): |
| 106 | return self.cget(key) |
| 107 | |
| 108 | def __setitem__(self, key, value): |
| 109 | self.configure(**{key: value}) |
| 110 | |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 111 | def __del__(self): |
| 112 | try: |
Martin v. Löwis | fe84d17 | 2004-08-18 11:06:45 +0000 | [diff] [blame] | 113 | if self.delete_font: |
| 114 | self._call("font", "delete", self.name) |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 115 | except (KeyboardInterrupt, SystemExit): |
| 116 | raise |
| 117 | except Exception: |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 118 | pass |
Tim Peters | a45cacf | 2004-08-20 03:47:14 +0000 | [diff] [blame] | 119 | |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 120 | def copy(self): |
| 121 | "Return a distinct copy of the current font" |
Raymond Hettinger | ff41c48 | 2003-04-06 09:01:11 +0000 | [diff] [blame] | 122 | return Font(self._root, **self.actual()) |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 123 | |
| 124 | def actual(self, option=None): |
| 125 | "Return actual font attributes" |
| 126 | if option: |
| 127 | return self._call("font", "actual", self.name, "-"+option) |
| 128 | else: |
| 129 | return self._mkdict( |
| 130 | self._split(self._call("font", "actual", self.name)) |
| 131 | ) |
| 132 | |
| 133 | def cget(self, option): |
| 134 | "Get font attribute" |
| 135 | return self._call("font", "config", self.name, "-"+option) |
| 136 | |
| 137 | def config(self, **options): |
| 138 | "Modify font attributes" |
| 139 | if options: |
Raymond Hettinger | ff41c48 | 2003-04-06 09:01:11 +0000 | [diff] [blame] | 140 | self._call("font", "config", self.name, |
| 141 | *self._set(options)) |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 142 | else: |
| 143 | return self._mkdict( |
Andrew Svetlov | 5af3e1a | 2012-04-03 09:39:47 +0300 | [diff] [blame^] | 144 | self._split(self._call("font", "config", self.name))) |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 145 | |
| 146 | configure = config |
Fred Drake | d038ca8 | 2000-10-23 18:31:14 +0000 | [diff] [blame] | 147 | |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 148 | def measure(self, text): |
| 149 | "Return text width" |
Eric S. Raymond | fc170b1 | 2001-02-09 11:51:27 +0000 | [diff] [blame] | 150 | return int(self._call("font", "measure", self.name, text)) |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 151 | |
| 152 | def metrics(self, *options): |
| 153 | """Return font metrics. |
| 154 | |
| 155 | For best performance, create a dummy widget |
| 156 | using this font before calling this method.""" |
| 157 | |
| 158 | if options: |
Eric S. Raymond | fc170b1 | 2001-02-09 11:51:27 +0000 | [diff] [blame] | 159 | return int( |
Andrew Svetlov | 5af3e1a | 2012-04-03 09:39:47 +0300 | [diff] [blame^] | 160 | self._call("font", "metrics", self.name, self._get(options))) |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 161 | else: |
| 162 | res = self._split(self._call("font", "metrics", self.name)) |
| 163 | options = {} |
| 164 | for i in range(0, len(res), 2): |
Eric S. Raymond | fc170b1 | 2001-02-09 11:51:27 +0000 | [diff] [blame] | 165 | options[res[i][1:]] = int(res[i+1]) |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 166 | return options |
| 167 | |
Andrew Svetlov | 5af3e1a | 2012-04-03 09:39:47 +0300 | [diff] [blame^] | 168 | |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 169 | def families(root=None): |
| 170 | "Get font families (as a tuple)" |
| 171 | if not root: |
Georg Brandl | 14fc427 | 2008-05-17 18:39:55 +0000 | [diff] [blame] | 172 | root = tkinter._default_root |
Fred Drake | d038ca8 | 2000-10-23 18:31:14 +0000 | [diff] [blame] | 173 | return root.tk.splitlist(root.tk.call("font", "families")) |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 174 | |
Andrew Svetlov | 5af3e1a | 2012-04-03 09:39:47 +0300 | [diff] [blame^] | 175 | |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 176 | def names(root=None): |
| 177 | "Get names of defined fonts (as a tuple)" |
| 178 | if not root: |
Georg Brandl | 14fc427 | 2008-05-17 18:39:55 +0000 | [diff] [blame] | 179 | root = tkinter._default_root |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 180 | return root.tk.splitlist(root.tk.call("font", "names")) |
| 181 | |
Andrew Svetlov | 5af3e1a | 2012-04-03 09:39:47 +0300 | [diff] [blame^] | 182 | |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 183 | # -------------------------------------------------------------------- |
| 184 | # test stuff |
Fred Drake | d038ca8 | 2000-10-23 18:31:14 +0000 | [diff] [blame] | 185 | |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 186 | if __name__ == "__main__": |
| 187 | |
Georg Brandl | 14fc427 | 2008-05-17 18:39:55 +0000 | [diff] [blame] | 188 | root = tkinter.Tk() |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 189 | |
| 190 | # create a font |
| 191 | f = Font(family="times", size=30, weight=NORMAL) |
| 192 | |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 193 | print(f.actual()) |
| 194 | print(f.actual("family")) |
| 195 | print(f.actual("weight")) |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 196 | |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 197 | print(f.config()) |
| 198 | print(f.cget("family")) |
| 199 | print(f.cget("weight")) |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 200 | |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 201 | print(names()) |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 202 | |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 203 | print(f.measure("hello"), f.metrics("linespace")) |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 204 | |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 205 | print(f.metrics()) |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 206 | |
| 207 | f = Font(font=("Courier", 20, "bold")) |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 208 | print(f.measure("hello"), f.metrics("linespace")) |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 209 | |
Georg Brandl | 14fc427 | 2008-05-17 18:39:55 +0000 | [diff] [blame] | 210 | w = tkinter.Label(root, text="Hello, world", font=f) |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 211 | w.pack() |
| 212 | |
Georg Brandl | 14fc427 | 2008-05-17 18:39:55 +0000 | [diff] [blame] | 213 | w = tkinter.Button(root, text="Quit!", command=root.destroy) |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 214 | w.pack() |
| 215 | |
| 216 | fb = Font(font=w["font"]).copy() |
| 217 | fb.config(weight=BOLD) |
Fred Drake | d038ca8 | 2000-10-23 18:31:14 +0000 | [diff] [blame] | 218 | |
Guido van Rossum | 3d16d3e | 1998-08-11 19:07:58 +0000 | [diff] [blame] | 219 | w.config(font=fb) |
| 220 | |
Georg Brandl | 14fc427 | 2008-05-17 18:39:55 +0000 | [diff] [blame] | 221 | tkinter.mainloop() |