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
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.FontPickerCtrl:
==========================================================================================================================================
|phoenix_title| **wx.FontPickerCtrl**
==========================================================================================================================================
This control allows the user to select a font.
The generic implementation is a button which brings up a :ref:`wx.FontDialog` when clicked. Native implementation may differ but this is usually a (small) widget which give access to the font-chooser dialog. It is only available if ``USE_FONTPICKERCTRL`` is set to 1 (the default).
.. _FontPickerCtrl-styles:
|styles| Window Styles
================================
This class supports the following styles:
- ``wx.FNTP_DEFAULT_STYLE``: The default style: ``wx.FNTP_FONTDESC_AS_LABEL`` | ``wx.FNTP_USEFONT_FOR_LABEL``.
- ``wx.FNTP_USE_TEXTCTRL``: Creates a text control to the left of the picker button which is completely managed by the :ref:`wx.FontPickerCtrl` and which can be used by the user to specify a font (see SetSelectedFont). The text control is automatically synchronized with button's value. Use functions defined in :ref:`wx.PickerBase` to modify the text control.
- ``wx.FNTP_FONTDESC_AS_LABEL``: Keeps the label of the button updated with the fontface name and the font size. E.g. choosing "Times New Roman bold, italic with
size 10" from the fontdialog, will update the label (overwriting any previous label) with the "Times New Roman, 10" text.
- ``wx.FNTP_USEFONT_FOR_LABEL``: Uses the currently selected font to draw the label of the button.
.. _FontPickerCtrl-events:
|events| Events Emitted by this Class
=====================================
Handlers bound for the following event types will receive a :ref:`wx.FontPickerEvent` parameter.
- EVT_FONTPICKER_CHANGED: The user changed the font selected in the control either using the button or using text control (see ``wx.FNTP_USE_TEXTCTRL``; note that in this case the event is fired only if the user's input is valid, i.e. recognizable).
.. seealso:: :ref:`wx.FontDialog`, :ref:`wx.FontPickerEvent`
|
|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>FontPickerCtrl</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.FontPickerCtrl_inheritance.png" alt="Inheritance diagram of FontPickerCtrl" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Control.html" title="wx.Control" alt="" coords="60,237,148,267"/> <area shape="rect" id="node7" href="wx.PickerBase.html" title="wx.PickerBase" alt="" coords="48,315,159,344"/> <area shape="rect" id="node2" href="wx.Window.html" title="wx.Window" alt="" coords="59,160,148,189"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="5,5,87,35"/> <area shape="rect" id="node4" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="48,83,159,112"/> <area shape="rect" id="node5" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="112,5,213,35"/> <area shape="rect" id="node6" href="wx.FontPickerCtrl.html" title="wx.FontPickerCtrl" alt="" coords="39,392,168,421"/> </map>
</p>
|
|appearance| Control Appearance
===============================
|
.. figure:: _static/images/widgets/fullsize/wxmsw/wx.fontpickerctrl.png
:alt: wxMSW
:figclass: floatleft
**wxMSW**
.. figure:: _static/images/widgets/fullsize/wxmac/wx.fontpickerctrl.png
:alt: wxMAC
:figclass: floatright
**wxMAC**
.. figure:: _static/images/widgets/fullsize/wxgtk/wx.fontpickerctrl.png
:alt: wxGTK
:figclass: floatcenter
**wxGTK**
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.FontPickerCtrl.__init__`
:meth:`~wx.FontPickerCtrl.Create` Creates this widget with given parameters.
:meth:`~wx.FontPickerCtrl.GetMaxPointSize` Returns the maximum point size value allowed for the user-chosen font.
:meth:`~wx.FontPickerCtrl.GetSelectedFont` Returns the currently selected font.
:meth:`~wx.FontPickerCtrl.SetMaxPointSize` Sets the maximum point size value allowed for the user-chosen font.
:meth:`~wx.FontPickerCtrl.SetSelectedFont` Sets the currently selected font.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.FontPickerCtrl.MaxPointSize` See :meth:`~wx.FontPickerCtrl.GetMaxPointSize` and :meth:`~wx.FontPickerCtrl.SetMaxPointSize`
:attr:`~wx.FontPickerCtrl.SelectedFont` See :meth:`~wx.FontPickerCtrl.GetSelectedFont` and :meth:`~wx.FontPickerCtrl.SetSelectedFont`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.FontPickerCtrl(PickerBase)
**Possible constructors**::
FontPickerCtrl()
FontPickerCtrl(parent, id=ID_ANY, font=NullFont, pos=DefaultPosition,
size=DefaultSize, style=FNTP_DEFAULT_STYLE, validator=DefaultValidator,
name=FontPickerCtrlNameStr)
This control allows the user to select a font.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self)`
**~~~**
**__init__** `(self, parent, id=ID_ANY, font=NullFont, pos=DefaultPosition, size=DefaultSize, style=FNTP_DEFAULT_STYLE, validator=DefaultValidator, name=FontPickerCtrlNameStr)`
Initializes the object and calls :meth:`Create` with all the parameters.
:param `parent`:
:type `parent`: wx.Window
:param `id`:
:type `id`: wx.WindowID
:param `font`:
:type `font`: wx.Font
:param `pos`:
:type `pos`: wx.Point
:param `size`:
:type `size`: wx.Size
:param `style`:
:type `style`: long
:param `validator`:
:type `validator`: wx.Validator
:param `name`:
:type `name`: string
**~~~**
.. method:: Create(self, parent, id=ID_ANY, font=NullFont, pos=DefaultPosition, size=DefaultSize, style=FNTP_DEFAULT_STYLE, validator=DefaultValidator, name=FontPickerCtrlNameStr)
Creates this widget with given parameters.
:param `parent`: Parent window, must not be non-NULL.
:type `parent`: wx.Window
:param `id`: The identifier for the control.
:type `id`: wx.WindowID
:param `font`: The initial font shown in the control. If :ref:`wx.NullFont` is given, the default font is used.
:type `font`: wx.Font
:param `pos`: Initial position.
:type `pos`: wx.Point
:param `size`: Initial size.
:type `size`: wx.Size
:param `style`: The window style, see ``FNTP_`` flags.
:type `style`: long
:param `validator`: Validator which can be used for additional date checks.
:type `validator`: wx.Validator
:param `name`: Control name.
:type `name`: string
:rtype: `bool`
:returns:
``True`` if the control was successfully created or ``False`` if creation failed.
.. method:: GetMaxPointSize(self)
Returns the maximum point size value allowed for the user-chosen font.
:rtype: `int`
.. method:: GetSelectedFont(self)
Returns the currently selected font.
Note that this function is completely different from :meth:`wx.Window.GetFont` .
:rtype: :ref:`wx.Font`
.. method:: SetMaxPointSize(self, max)
Sets the maximum point size value allowed for the user-chosen font.
The default value is 100. Note that big fonts can require a lot of memory and ``CPU`` time both for creation and for rendering; thus, specially because the user has the option to specify the fontsize through a text control (see ``wx.FNTP_USE_TEXTCTRL``), it's a good idea to put a limit to the maximum font size when huge fonts do not make much sense.
:param `max`:
:type `max`: int
.. method:: SetSelectedFont(self, font)
Sets the currently selected font.
Note that this function is completely different from :meth:`wx.Window.SetFont` .
:param `font`:
:type `font`: wx.Font
.. attribute:: MaxPointSize
See :meth:`~wx.FontPickerCtrl.GetMaxPointSize` and :meth:`~wx.FontPickerCtrl.SetMaxPointSize`
.. attribute:: SelectedFont
See :meth:`~wx.FontPickerCtrl.GetSelectedFont` and :meth:`~wx.FontPickerCtrl.SetSelectedFont`
|
