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
|
.. 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.FontData:
==========================================================================================================================================
|phoenix_title| **wx.FontData**
==========================================================================================================================================
This class holds a variety of information related to font dialogs.
.. seealso:: :ref:`FontDialog Overview <fontdialog overview>`, :ref:`wx.Font`, :ref:`wx.FontDialog`
|
|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>FontData</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.FontData_inheritance.png" alt="Inheritance diagram of FontData" 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.FontData.html" title="wx.FontData" alt="" coords="5,83,109,112"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="14,5,101,35"/> </map>
</p>
</div>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.FontData.__init__` Constructor.
:meth:`~wx.FontData.EnableEffects` Enables or disables "effects" under Windows or generic only.
:meth:`~wx.FontData.GetAllowSymbols` Under Windows, returns a flag determining whether symbol fonts can be selected.
:meth:`~wx.FontData.GetChosenFont` Gets the font chosen by the user if the user pressed ``wx.OK`` (:meth:`wx.FontDialog.ShowModal` returned ``wx.ID_OK``).
:meth:`~wx.FontData.GetColour` Gets the colour associated with the font dialog.
:meth:`~wx.FontData.GetEnableEffects` Determines whether "effects" are enabled under Windows.
:meth:`~wx.FontData.GetInitialFont` Gets the font that will be initially used by the font dialog.
:meth:`~wx.FontData.GetRestrictSelection` Returns the state of the flags restricting the selection.
:meth:`~wx.FontData.GetShowHelp` Returns ``True`` if the Help button will be shown (Windows only).
:meth:`~wx.FontData.RestrictSelection` Restricts the selection to a subset of the available fonts.
:meth:`~wx.FontData.SetAllowSymbols` Under Windows, determines whether symbol fonts can be selected.
:meth:`~wx.FontData.SetChosenFont` Sets the font that will be returned to the user (for internal use only).
:meth:`~wx.FontData.SetColour` Sets the colour that will be used for the font foreground colour.
:meth:`~wx.FontData.SetInitialFont` Sets the font that will be initially used by the font dialog.
:meth:`~wx.FontData.SetRange` Sets the valid range for the font point size (Windows only).
:meth:`~wx.FontData.SetShowHelp` Determines whether the Help button will be displayed in the font dialog (Windows only).
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.FontData.AllowSymbols` See :meth:`~wx.FontData.GetAllowSymbols` and :meth:`~wx.FontData.SetAllowSymbols`
:attr:`~wx.FontData.ChosenFont` See :meth:`~wx.FontData.GetChosenFont` and :meth:`~wx.FontData.SetChosenFont`
:attr:`~wx.FontData.Colour` See :meth:`~wx.FontData.GetColour` and :meth:`~wx.FontData.SetColour`
:attr:`~wx.FontData.InitialFont` See :meth:`~wx.FontData.GetInitialFont` and :meth:`~wx.FontData.SetInitialFont`
:attr:`~wx.FontData.ShowHelp` See :meth:`~wx.FontData.GetShowHelp` and :meth:`~wx.FontData.SetShowHelp`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.FontData(Object)
**Possible constructors**::
FontData()
This class holds a variety of information related to font dialogs.
.. method:: __init__(self)
Constructor.
Initializes `fontColour` to black, `showHelp` to ``False``, `allowSymbols` to ``True``, `enableEffects` to ``True``, `minSize` to 0 and `maxSize` to 0.
.. method:: EnableEffects(self, enable)
Enables or disables "effects" under Windows or generic only.
This refers to the controls for manipulating colour, strikeout and underline properties.
The default value is ``True``.
:param `enable`:
:type `enable`: bool
.. method:: GetAllowSymbols(self)
Under Windows, returns a flag determining whether symbol fonts can be selected.
Has no effect on other platforms.
The default value is ``True``.
:rtype: `bool`
.. method:: GetChosenFont(self)
Gets the font chosen by the user if the user pressed ``wx.OK`` (:meth:`wx.FontDialog.ShowModal` returned ``wx.ID_OK``).
:rtype: :ref:`wx.Font`
.. method:: GetColour(self)
Gets the colour associated with the font dialog.
The default value is black.
:rtype: :ref:`wx.Colour`
.. method:: GetEnableEffects(self)
Determines whether "effects" are enabled under Windows.
This refers to the controls for manipulating colour, strikeout and underline properties.
The default value is ``True``.
:rtype: `bool`
.. method:: GetInitialFont(self)
Gets the font that will be initially used by the font dialog.
This should have previously been set by the application.
:rtype: :ref:`wx.Font`
.. method:: GetRestrictSelection(self)
Returns the state of the flags restricting the selection.
Note that currently these flags are only effectively used in wxMSW.
The default value is ``FONTRESTRICT_NONE`` .
:rtype: `int`
:returns:
- ``FONTRESTRICT_NONE`` If no restriction applies, or a combination of the following flags:
- ``FONTRESTRICT_SCALABLE`` To show only scalable fonts - no raster fonts.
- ``FONTRESTRICT_FIXEDPITCH`` To show only monospaced fonts.
.. versionadded:: 4.1/wxWidgets-3.1.4
.. method:: GetShowHelp(self)
Returns ``True`` if the Help button will be shown (Windows only).
The default value is ``False``.
:rtype: `bool`
.. method:: RestrictSelection(self, flags)
Restricts the selection to a subset of the available fonts.
Note that currently these flags are only effectively used in wxMSW and are ignored in the other ports.
Possible values are:
- ``FONTRESTRICT_NONE`` No restriction, show all fonts in the dialog.
- ``FONTRESTRICT_SCALABLE`` To show only scalable fonts - no raster fonts.
- ``FONTRESTRICT_FIXEDPITCH`` To show only monospaced fonts.
The default value is ``FONTRESTRICT_NONE`` .
:param `flags`:
:type `flags`: int
.. versionadded:: 4.1/wxWidgets-3.1.4
.. method:: SetAllowSymbols(self, allowSymbols)
Under Windows, determines whether symbol fonts can be selected.
Has no effect on other platforms.
The default value is ``True``.
:param `allowSymbols`:
:type `allowSymbols`: bool
.. method:: SetChosenFont(self, font)
Sets the font that will be returned to the user (for internal use only).
:param `font`:
:type `font`: wx.Font
.. method:: SetColour(self, colour)
Sets the colour that will be used for the font foreground colour.
The default colour is black.
:param `colour`:
:type `colour`: wx.Colour
.. method:: SetInitialFont(self, font)
Sets the font that will be initially used by the font dialog.
:param `font`:
:type `font`: wx.Font
.. method:: SetRange(self, min, max)
Sets the valid range for the font point size (Windows only).
The default is 0, 0 (unrestricted range).
:param `min`:
:type `min`: int
:param `max`:
:type `max`: int
.. method:: SetShowHelp(self, showHelp)
Determines whether the Help button will be displayed in the font dialog (Windows only).
The default value is ``False``.
:param `showHelp`:
:type `showHelp`: bool
.. attribute:: AllowSymbols
See :meth:`~wx.FontData.GetAllowSymbols` and :meth:`~wx.FontData.SetAllowSymbols`
.. attribute:: ChosenFont
See :meth:`~wx.FontData.GetChosenFont` and :meth:`~wx.FontData.SetChosenFont`
.. attribute:: Colour
See :meth:`~wx.FontData.GetColour` and :meth:`~wx.FontData.SetColour`
.. attribute:: InitialFont
See :meth:`~wx.FontData.GetInitialFont` and :meth:`~wx.FontData.SetInitialFont`
.. attribute:: ShowHelp
See :meth:`~wx.FontData.GetShowHelp` and :meth:`~wx.FontData.SetShowHelp`
|
