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
|
# (C) Copyright 2008-2023 Enthought, Inc., Austin, TX
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in LICENSE.txt and may be redistributed only under
# the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
#
# Thanks for using Enthought open source!
# ------------------------------------------------------------------------------
# Copyright (c) 2007, Riverbank Computing Limited
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD license.
# However, when used with the GPL version of PyQt the additional terms
# described in the PyQt GPL exception also apply
#
# Author: Riverbank Computing Limited
# ------------------------------------------------------------------------------
""" Trait definition for a PyQt-based font.
"""
from pyface.qt import QtGui
from pyface.font import Font as PyfaceFont
from traits.api import Trait, TraitHandler, TraitError
# -------------------------------------------------------------------------
# Convert a string into a valid QFont object (if possible):
# -------------------------------------------------------------------------
# Mapping of strings to valid QFont style hints.
font_families = {
"default": QtGui.QFont.StyleHint.AnyStyle,
"decorative": QtGui.QFont.StyleHint.Decorative,
"roman": QtGui.QFont.StyleHint.Serif,
"script": QtGui.QFont.StyleHint.Cursive,
"swiss": QtGui.QFont.StyleHint.SansSerif,
"modern": QtGui.QFont.StyleHint.TypeWriter,
}
# Mapping of strings to QFont styles.
font_styles = {
"slant": QtGui.QFont.Style.StyleOblique,
"oblique": QtGui.QFont.Style.StyleOblique,
"italic": QtGui.QFont.Style.StyleItalic,
}
# Mapping of strings to QFont weights.
font_weights = {"light": QtGui.QFont.Weight.Light, "bold": QtGui.QFont.Weight.Bold}
# Strings to ignore in text representations of fonts
font_noise = ["pt", "point", "family"]
def font_to_str(font):
"""Converts a QFont into a string description of itself."""
style_hint = {
QtGui.QFont.StyleHint.Decorative: "decorative",
QtGui.QFont.StyleHint.Serif: "roman",
QtGui.QFont.StyleHint.Cursive: "script",
QtGui.QFont.StyleHint.SansSerif: "swiss",
QtGui.QFont.StyleHint.TypeWriter: "modern",
}.get(font.styleHint(), "")
weight = {QtGui.QFont.Weight.Light: " Light", QtGui.QFont.Weight.Bold: " Bold"}.get(
font.weight(), ""
)
style = {
QtGui.QFont.Style.StyleOblique: " Oblique",
QtGui.QFont.Style.StyleItalic: " Italic",
}.get(font.style(), "")
underline = ""
if font.underline():
underline = " underline"
return "%s point %s%s%s%s" % (
font.pointSize(),
str(font.family()),
style,
weight,
underline,
)
def create_traitsfont(value):
"""Create a TraitsFont object.
This can take either a string description, a QFont, or a Pyface Font.
"""
if isinstance(value, PyfaceFont):
return TraitsFont(value.to_toolkit())
if isinstance(value, QtGui.QFont):
return TraitsFont(value)
point_size = None
family = ""
style_hint = QtGui.QFont.StyleHint.AnyStyle
style = QtGui.QFont.Style.StyleNormal
weight = QtGui.QFont.Weight.Normal
underline = False
facename = []
for word in value.split():
lword = word.lower()
if lword in font_families:
style_hint = font_families[lword]
elif lword in font_styles:
style = font_styles[lword]
elif lword in font_weights:
weight = font_weights[lword]
elif lword == "underline":
underline = True
elif lword not in font_noise:
if point_size is None:
try:
point_size = int(lword)
continue
except ValueError:
pass
facename.append(word)
if facename:
family = " ".join(facename)
if family:
fnt = TraitsFont(family)
else:
fnt = TraitsFont()
fnt.setStyleHint(style_hint)
fnt.setStyle(style)
fnt.setWeight(weight)
fnt.setUnderline(underline)
if point_size is None:
fnt.setPointSize(QtGui.QApplication.font().pointSize())
else:
fnt.setPointSize(point_size)
return fnt
class TraitsFont(QtGui.QFont):
"""A Traits-specific QFont."""
def __reduce_ex__(self, protocol):
"""Returns the pickleable form of a TraitsFont object."""
return (create_traitsfont, (font_to_str(self),))
def __str__(self):
"""Returns a printable form of the font."""
return font_to_str(self)
# -------------------------------------------------------------------------
# 'TraitPyQtFont' class'
# -------------------------------------------------------------------------
class TraitPyQtFont(TraitHandler):
"""Ensures that values assigned to a trait attribute are valid font
descriptor strings; the value actually assigned is the corresponding
TraitsFont.
"""
def validate(self, object, name, value):
"""Validates that the value is a valid font descriptor string. If so,
it returns the corresponding TraitsFont; otherwise, it raises a
TraitError.
"""
if value is None:
return None
try:
return create_traitsfont(value)
except:
pass
raise TraitError(object, name, "a font descriptor string", repr(value))
def info(self):
return (
"a string describing a font (e.g. '12 pt bold italic "
"swiss family Arial' or 'default 12')"
)
# -------------------------------------------------------------------------
# Callable that returns an instance of the PyQtToolkitEditorFactory for font
# editors.
# -------------------------------------------------------------------------
### FIXME: We have declared the 'editor' to be a function instead of the
# traitsui.qt.font_editor.ToolkitEditorFactory class, since the
# latter is leading to too many circular imports. In the future, try to see if
# there is a better way to do this.
def get_font_editor(*args, **traits):
from traitsui.qt.font_editor import ToolkitEditorFactory
return ToolkitEditorFactory(*args, **traits)
# -------------------------------------------------------------------------
# Define a PyQt specific font trait:
# -------------------------------------------------------------------------
PyQtFont = Trait(TraitsFont(), TraitPyQtFont(), editor=get_font_editor)
|
