Repository navigation
Expand file tree
/
Copy pathfont.py
More file actions
395 lines (335 loc) · 11.3 KB
/
Copy pathfont.py
File metadata and controls
395 lines (335 loc) · 11.3 KB
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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
# encoding: utf-8
"""
Font-related proxy objects.
"""
from __future__ import (
absolute_import, division, print_function, unicode_literals
)
from ..dml.color import ColorFormat
from ..shared import ElementProxy
class Font(ElementProxy):
"""
Proxy object wrapping the parent of a ``<w:rPr>`` element and providing
access to character properties such as font name, font size, bold, and
subscript.
"""
__slots__ = ()
@property
def all_caps(self):
"""
Read/write. Causes text in this font to appear in capital letters.
"""
return self._get_bool_prop('caps')
@all_caps.setter
def all_caps(self, value):
self._set_bool_prop('caps', value)
@property
def bold(self):
"""
Read/write. Causes text in this font to appear in bold.
"""
return self._get_bool_prop('b')
@bold.setter
def bold(self, value):
self._set_bool_prop('b', value)
@property
def color(self):
"""
A |ColorFormat| object providing a way to get and set the text color
for this font.
"""
return ColorFormat(self._element)
@property
def complex_script(self):
"""
Read/write tri-state value. When |True|, causes the characters in the
run to be treated as complex script regardless of their Unicode
values.
"""
return self._get_bool_prop('cs')
@complex_script.setter
def complex_script(self, value):
self._set_bool_prop('cs', value)
@property
def cs_bold(self):
"""
Read/write tri-state value. When |True|, causes the complex script
characters in the run to be displayed in bold typeface.
"""
return self._get_bool_prop('bCs')
@cs_bold.setter
def cs_bold(self, value):
self._set_bool_prop('bCs', value)
@property
def cs_italic(self):
"""
Read/write tri-state value. When |True|, causes the complex script
characters in the run to be displayed in italic typeface.
"""
return self._get_bool_prop('iCs')
@cs_italic.setter
def cs_italic(self, value):
self._set_bool_prop('iCs', value)
@property
def double_strike(self):
"""
Read/write tri-state value. When |True|, causes the text in the run
to appear with double strikethrough.
"""
return self._get_bool_prop('dstrike')
@double_strike.setter
def double_strike(self, value):
self._set_bool_prop('dstrike', value)
@property
def emboss(self):
"""
Read/write tri-state value. When |True|, causes the text in the run
to appear as if raised off the page in relief.
"""
return self._get_bool_prop('emboss')
@emboss.setter
def emboss(self, value):
self._set_bool_prop('emboss', value)
@property
def hidden(self):
"""
Read/write tri-state value. When |True|, causes the text in the run
to be hidden from display, unless applications settings force hidden
text to be shown.
"""
return self._get_bool_prop('vanish')
@hidden.setter
def hidden(self, value):
self._set_bool_prop('vanish', value)
@property
def italic(self):
"""
Read/write tri-state value. When |True|, causes the text of the run
to appear in italics. |None| indicates the effective value is
inherited from the style hierarchy.
"""
return self._get_bool_prop('i')
@italic.setter
def italic(self, value):
self._set_bool_prop('i', value)
@property
def imprint(self):
"""
Read/write tri-state value. When |True|, causes the text in the run
to appear as if pressed into the page.
"""
return self._get_bool_prop('imprint')
@imprint.setter
def imprint(self, value):
self._set_bool_prop('imprint', value)
@property
def math(self):
"""
Read/write tri-state value. When |True|, specifies this run contains
WML that should be handled as though it was Office Open XML Math.
"""
return self._get_bool_prop('oMath')
@math.setter
def math(self, value):
self._set_bool_prop('oMath', value)
@property
def name(self):
"""
Get or set the typeface name for this |Font| instance, causing the
text it controls to appear in the named font, if a matching font is
found. |None| indicates the typeface is inherited from the style
hierarchy.
"""
rPr = self._element.rPr
if rPr is None:
return None
return rPr.rFonts_ascii
@name.setter
def name(self, value):
rPr = self._element.get_or_add_rPr()
rPr.rFonts_ascii = value
rPr.rFonts_hAnsi = value
@property
def no_proof(self):
"""
Read/write tri-state value. When |True|, specifies that the contents
of this run should not report any errors when the document is scanned
for spelling and grammar.
"""
return self._get_bool_prop('noProof')
@no_proof.setter
def no_proof(self, value):
self._set_bool_prop('noProof', value)
@property
def outline(self):
"""
Read/write tri-state value. When |True| causes the characters in the
run to appear as if they have an outline, by drawing a one pixel wide
border around the inside and outside borders of each character glyph.
"""
return self._get_bool_prop('outline')
@outline.setter
def outline(self, value):
self._set_bool_prop('outline', value)
@property
def rtl(self):
"""
Read/write tri-state value. When |True| causes the text in the run
to have right-to-left characteristics.
"""
return self._get_bool_prop('rtl')
@rtl.setter
def rtl(self, value):
self._set_bool_prop('rtl', value)
@property
def shadow(self):
"""
Read/write tri-state value. When |True| causes the text in the run
to appear as if each character has a shadow.
"""
return self._get_bool_prop('shadow')
@shadow.setter
def shadow(self, value):
self._set_bool_prop('shadow', value)
@property
def size(self):
"""
Read/write |Length| value or |None|, indicating the font height in
English Metric Units (EMU). |None| indicates the font size should be
inherited from the style hierarchy. |Length| is a subclass of |int|
having properties for convenient conversion into points or other
length units. The :class:`docx.shared.Pt` class allows convenient
specification of point values::
>> font.size = Pt(24)
>> font.size
304800
>> font.size.pt
24.0
"""
rPr = self._element.rPr
if rPr is None:
return None
return rPr.sz_val
@size.setter
def size(self, emu):
rPr = self._element.get_or_add_rPr()
rPr.sz_val = emu
@property
def small_caps(self):
"""
Read/write tri-state value. When |True| causes the lowercase
characters in the run to appear as capital letters two points smaller
than the font size specified for the run.
"""
return self._get_bool_prop('smallCaps')
@small_caps.setter
def small_caps(self, value):
self._set_bool_prop('smallCaps', value)
@property
def snap_to_grid(self):
"""
Read/write tri-state value. When |True| causes the run to use the
document grid characters per line settings defined in the docGrid
element when laying out the characters in this run.
"""
return self._get_bool_prop('snapToGrid')
@snap_to_grid.setter
def snap_to_grid(self, value):
self._set_bool_prop('snapToGrid', value)
@property
def spec_vanish(self):
"""
Read/write tri-state value. When |True|, specifies that the given run
shall always behave as if it is hidden, even when hidden text is
being displayed in the current document. The property has a very
narrow, specialized use related to the table of contents. Consult the
spec (§17.3.2.36) for more details.
"""
return self._get_bool_prop('specVanish')
@spec_vanish.setter
def spec_vanish(self, value):
self._set_bool_prop('specVanish', value)
@property
def strike(self):
"""
Read/write tri-state value. When |True| causes the text in the run
to appear with a single horizontal line through the center of the
line.
"""
return self._get_bool_prop('strike')
@strike.setter
def strike(self, value):
self._set_bool_prop('strike', value)
@property
def subscript(self):
"""
Boolean indicating whether the characters in this |Font| appear as
subscript. |None| indicates the subscript/subscript value is
inherited from the style hierarchy.
"""
rPr = self._element.rPr
if rPr is None:
return None
return rPr.subscript
@subscript.setter
def subscript(self, value):
rPr = self._element.get_or_add_rPr()
rPr.subscript = value
@property
def superscript(self):
"""
Boolean indicating whether the characters in this |Font| appear as
superscript. |None| indicates the subscript/superscript value is
inherited from the style hierarchy.
"""
rPr = self._element.rPr
if rPr is None:
return None
return rPr.superscript
@superscript.setter
def superscript(self, value):
rPr = self._element.get_or_add_rPr()
rPr.superscript = value
@property
def underline(self):
"""
The underline style for this |Font|, one of |None|, |True|, |False|,
or a value from :ref:`WdUnderline`. |None| indicates the font
inherits its underline value from the style hierarchy. |False|
indicates no underline. |True| indicates single underline. The values
from :ref:`WdUnderline` are used to specify other outline styles such
as double, wavy, and dotted.
"""
rPr = self._element.rPr
if rPr is None:
return None
return rPr.u_val
@underline.setter
def underline(self, value):
rPr = self._element.get_or_add_rPr()
rPr.u_val = value
@property
def web_hidden(self):
"""
Read/write tri-state value. When |True|, specifies that the contents
of this run shall be hidden when the document is displayed in web
page view.
"""
return self._get_bool_prop('webHidden')
@web_hidden.setter
def web_hidden(self, value):
self._set_bool_prop('webHidden', value)
def _get_bool_prop(self, name):
"""
Return the value of boolean child of `w:rPr` having *name*.
"""
rPr = self._element.rPr
if rPr is None:
return None
return rPr._get_bool_val(name)
def _set_bool_prop(self, name, value):
"""
Assign *value* to the boolean child *name* of `w:rPr`.
"""
rPr = self._element.get_or_add_rPr()
rPr._set_bool_val(name, value)