wx.FontPickerCtrl

Inheritance diagram for wx.FontPickerCtrl:

Description

This control allows the user to select a font. The generic implementation is a button which brings up a 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 wx.USE_FONTPICKERCTRL is set to 1 (the default).

See also

wx.FontDialog, wx.FontPickerEvent

Derived From

• wx.PickerBase
• wx.Control
• wx.Window
• wx.EvtHandler
• wx.Object

Window Styles

Window Style	Description
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 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.
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.

Event Handling

Event Name	Description
wx.EVT_FONTPICKER_CHANGED(id, func)	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).

Control Appearance

wxMSW

wxMAC

wxGTK

Methods Summary

• __init__
• GetMaxPointSize
• GetSelectedFont
• SetMaxPointSize
• SetSelectedFont

Properties Summary

• MaxPointSize
• SelectedFont

Class API

Methods

__init__(parent, id=-1, initial=wx.NullFont, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.FNTP_DEFAULT_STYLE, validator=wx.DefaultValidator, name=wx.FontPickerCtrlNameStr)

Constructor.

Parameters:

• parent (wx.Window)
• id (int)
• initial (wx.Font)
• pos (wx.Point)
• size (wx.Size)
• style (long)
• validator (wx.Validator)
• name (string)

Returns:

wx.FontPickerCtrl

---

GetMaxPointSize()

Returns the maximum point size value allowed for the user-chosen font.

Returns:

unsigned int

---

GetSelectedFont()

Returns the currently selected font.

Returns:

wx.Font

Note

Note that this function is completely different from wx.Window.GetFont

---

SetMaxPointSize(max)

Sets the maximum point size value allowed for the user-chosen font.

The default value is 100.

Parameters:

• max (int)

Note

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.

---

SetSelectedFont(font)

Sets the currently selected font.

Parameters:

• font (wx.Font)

Note

Note that this function is completely different from wx.Window.SetFont

---

Properties

MaxPointSize

See GetMaxPointSize and SetMaxPointSize

SelectedFont

See GetSelectedFont and SetSelectedFont