Phoenix Logo

phoenix_title wx.FontPickerCtrl

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 USE_FONTPICKERCTRL is set to 1 (the default).

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 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 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.

events Events Emitted by this Class

Handlers bound for the following event types will receive a 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).

class_hierarchy Class Hierarchy

Inheritance diagram for class FontPickerCtrl:


appearance Control Appearance


wxMSW

wxMSW

wxMAC

wxMAC

wxGTK

wxGTK


method_summary Methods Summary

__init__  
Create Creates this widget with given parameters.
GetMaxPointSize Returns the maximum point size value allowed for the user-chosen font.
GetSelectedFont Returns the currently selected font.
SetMaxPointSize Sets the maximum point size value allowed for the user-chosen font.
SetSelectedFont Sets the currently selected font.

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.


Methods



__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 Create with all the parameters.

Parameters:





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.

Parameters:
  • parent (wx.Window) – Parent window, must not be not None.
  • id (wx.WindowID) – The identifier for the control.
  • font (wx.Font) – The initial font shown in the control. If wx.NullFont is given, the default font is used.
  • pos (wx.Point) – Initial position.
  • size (wx.Size) – Initial size.
  • style (long) – The window style, see FNTP_ flags.
  • validator (wx.Validator) – Validator which can be used for additional date checks.
  • name (string) – Control name.
Return type:

bool

Returns:

True if the control was successfully created or False if creation failed.



GetMaxPointSize(self)

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

Return type:int


GetSelectedFont(self)

Returns the currently selected font.

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

Return type: wx.Font


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.

Parameters:max (int) –


SetSelectedFont(self, font)

Sets the currently selected font.

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

Parameters:font (wx.Font) –

Properties



MaxPointSize

See GetMaxPointSize and SetMaxPointSize



SelectedFont

See GetSelectedFont and SetSelectedFont