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
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.FontInfo:
==========================================================================================================================================
|phoenix_title| **wx.FontInfo**
==========================================================================================================================================
This class is a helper used for :ref:`wx.Font` creation using named parameter idiom: it allows specifying various :ref:`wx.Font` attributes using the chained calls to its clearly named methods instead of passing them in the fixed order to :ref:`wx.Font` constructors.
For example, to create an italic font with the given face name and size you could use: ::
font = wx.Font(wx.FontInfo(12).FaceName("Helvetica").Italic())
Notice that all of the methods of this object return a reference to the object itself, allowing the calls to them to be chained as in the example above.
All methods taking boolean parameters can be used to turn the specified font attribute on or off and turn it on by default.
.. versionadded:: 2.9.5
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>FontInfo</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.FontInfo_inheritance.png" alt="Inheritance diagram of FontInfo" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.FontInfo.html" title="wx.FontInfo" alt="" coords="5,5,104,35"/> </map>
</p>
</div>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.FontInfo.__init__` Default constructor uses the default font size for the current platform.
:meth:`~wx.FontInfo.AllFlags` Set all the font attributes at once.
:meth:`~wx.FontInfo.AntiAliased` Set anti-aliasing flag.
:meth:`~wx.FontInfo.Bold` Use a bold version of the font.
:meth:`~wx.FontInfo.Encoding` Set the font encoding to use.
:meth:`~wx.FontInfo.FaceName` Set the font face name to use.
:meth:`~wx.FontInfo.Family` Set the font family.
:meth:`~wx.FontInfo.GetWeightClosestToNumericValue` Get the symbolic weight closest to the given raw weight value.
:meth:`~wx.FontInfo.Italic` Use an italic version of the font.
:meth:`~wx.FontInfo.Light` Use a lighter version of the font.
:meth:`~wx.FontInfo.Slant` Use a slanted version of the font.
:meth:`~wx.FontInfo.Strikethrough` Use a strike-through version of the font.
:meth:`~wx.FontInfo.Style` Specify the style of the font using one of FontStyle constants.
:meth:`~wx.FontInfo.Underlined` Use an underlined version of the font.
:meth:`~wx.FontInfo.Weight` Specify the weight of the font.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.FontInfo(object)
**Possible constructors**::
FontInfo()
FontInfo(pointSize)
FontInfo(pixelSize)
This class is a helper used for Font creation using named parameter
idiom: it allows specifying various Font attributes using the
chained calls to its clearly named methods instead of passing them in
the fixed order to Font constructors.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self)`
Default constructor uses the default font size for the current platform.
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self, pointSize)`
Constructor setting the font size in points to use.
Note that until wxWidgets 3.1.2 fractional point sizes were not supported, and the type of `pointSize` was ``int`` .
:param `pointSize`:
:type `pointSize`: float
.. seealso:: :meth:`wx.Font.SetPointSize`
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self, pixelSize)`
Constructor setting the font size in pixels to use.
:param `pixelSize`:
:type `pixelSize`: wx.Size
.. seealso:: :meth:`wx.Font.SetPixelSize`
:html:`<hr class="overloadsep" /><br />`
.. method:: AllFlags(self, flags)
Set all the font attributes at once.
See :ref:`wx.FontFlag` for the various flags that can be used.
Note that calling this method affects the font weight stored in this object: it is set to ``FONTWEIGHT_LIGHT`` or ``FONTWEIGHT_BOLD`` if the corresponding flag is present in `flags`, or ``FONTWEIGHT_NORMAL`` otherwise.
:param `flags`:
:type `flags`: int
:rtype: :ref:`wx.FontInfo`
.. method:: AntiAliased(self, antiAliased=True)
Set anti-aliasing flag.
Force the use of anti-aliasing on or off.
Currently this is not implemented, i.e. using this method doesn't do anything.
:param `antiAliased`:
:type `antiAliased`: bool
:rtype: :ref:`wx.FontInfo`
.. method:: Bold(self, bold=True)
Use a bold version of the font.
This is a wrapper for :meth:`Weight` calling it with ``FONTWEIGHT_BOLD`` argument.
:param `bold`:
:type `bold`: bool
:rtype: :ref:`wx.FontInfo`
.. seealso:: :ref:`wx.FontWeight`, :meth:`wx.Font.SetWeight`
.. method:: Encoding(self, encoding)
Set the font encoding to use.
This is mostly unneeded in Unicode builds of wxWidgets.
:param `encoding`:
:type `encoding`: wx.FontEncoding
:rtype: :ref:`wx.FontInfo`
.. seealso:: :ref:`wx.FontEncoding`, :meth:`wx.Font.SetEncoding`
.. method:: FaceName(self, faceName)
Set the font face name to use.
Face names are not portable, so prefer to use :meth:`Family` in portable code.
:param `faceName`:
:type `faceName`: string
:rtype: :ref:`wx.FontInfo`
.. seealso:: :meth:`wx.Font.SetFaceName`
.. method:: Family(self, family)
Set the font family.
The family is a generic portable way of referring to fonts without specifying a precise face name. This parameter must be one of the :ref:`wx.FontFamily` enumeration values.
If the :meth:`FaceName` is used, then it overrides the font family.
:param `family`:
:type `family`: wx.FontFamily
:rtype: :ref:`wx.FontInfo`
.. seealso:: :meth:`wx.Font.SetFamily`
.. staticmethod:: GetWeightClosestToNumericValue(numWeight)
Get the symbolic weight closest to the given raw weight value.
:param `numWeight`: A valid raw weight value, i.e. a value in the range 1 to 1000, inclusive.
:type `numWeight`: int
:rtype: :ref:`wx.FontWeight`
:returns:
A valid element of FontWeight enum.
.. versionadded:: 4.1/wxWidgets-3.1.2
.. method:: Italic(self, italic=True)
Use an italic version of the font.
This is a wrapper for :meth:`Style` calling it with ``FONTSTYLE_ITALIC`` argument.
:param `italic`:
:type `italic`: bool
:rtype: :ref:`wx.FontInfo`
.. seealso:: :ref:`wx.FontStyle`, :meth:`wx.Font.SetStyle`
.. method:: Light(self, light=True)
Use a lighter version of the font.
This is a wrapper for :meth:`Weight` calling it with ``FONTWEIGHT_LIGHT`` argument.
:param `light`:
:type `light`: bool
:rtype: :ref:`wx.FontInfo`
.. seealso:: :ref:`wx.FontWeight`, :meth:`wx.Font.SetWeight`
.. method:: Slant(self, slant=True)
Use a slanted version of the font.
This is a wrapper for :meth:`Style` calling it with ``FONTSTYLE_SLANT`` argument.
:param `slant`:
:type `slant`: bool
:rtype: :ref:`wx.FontInfo`
.. seealso:: :ref:`wx.FontStyle`, :meth:`wx.Font.SetStyle`
.. method:: Strikethrough(self, strikethrough=True)
Use a strike-through version of the font.
Currently this is only implemented in wxMSW, wxGTK, and wxOSX.
:param `strikethrough`:
:type `strikethrough`: bool
:rtype: :ref:`wx.FontInfo`
.. method:: Style(self, style)
Specify the style of the font using one of FontStyle constants.
:param `style`:
:type `style`: wx.FontStyle
:rtype: :ref:`wx.FontInfo`
.. versionadded:: 4.1/wxWidgets-3.1.2
.. method:: Underlined(self, underlined=True)
Use an underlined version of the font.
:param `underlined`:
:type `underlined`: bool
:rtype: :ref:`wx.FontInfo`
.. method:: Weight(self, weight)
Specify the weight of the font.
:param `weight`: A font weight in the range from 1 to 1000, inclusive, with 1 being the thinnest and 1000 the heaviest possible font variant. ``FONTWEIGHT_XXX`` values from FontWeight enum can be used here.
:type `weight`: int
:rtype: :ref:`wx.FontInfo`
.. versionadded:: 4.1/wxWidgets-3.1.2
|
