wxFontPickerCtrl(3erl)

🎀 NAME 🎀

okay bestie, this is the wxFontPickerCtrl page from the Erlang module definition — manual name wxFontPickerCtrl(3erl). It’s literally wxFontPickerCtrl — Functions for wxFontPickerCtrl class. 💅✨

🌸 DESCRIPTION 🌸

This control is main character energy for font picking: it allows the user to select a font. The generic implementation is a button which brings up a wxFontDialog 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 wxUSE_FONTPICKERCTRL is set to 1 (the default). 🎨

Styles: This class supports the following styles:

(no extra style items listed in the original, bestie — just that line, so we’re not inventing any 💀)

See: wxFontDialog, wxFontPickerEvent

This class is derived (and can use functions) from: wxPickerBase wxControl wxWindow wxEvtHandler

wxWidgets docs: wxFontPickerCtrl

🦋 EVENTS 🦋

Event types emitted from this class: command_fontpicker_changed

🌈 DATA TYPES 🌈

wxFontPickerCtrl() = wx:wx_object()

👑 EXPORTS 👑

new() -> wxFontPickerCtrl()

new(Parent, Id) -> wxFontPickerCtrl()

Types:

Parent = wxWindow:wxWindow()
Id = integer()

This one has no extra description in the original, just the types. iykyk 🫶

new(Parent, Id, Options :: [Option]) -> wxFontPickerCtrl()

Types:

Parent = wxWindow:wxWindow()
Id = integer()
Option =
    {initial, wxFont:wxFont()} |
    {pos, {X :: integer(), Y :: integer()}} |
    {size, {W :: integer(), H :: integer()}} |
    {style, integer()} |
    {validator, wx:wx_object()}

Initializes the object and calls create/4 with all the parameters. 🛠️

create(This, Parent, Id) -> boolean()

Types:

This = wxFontPickerCtrl()
Parent = wxWindow:wxWindow()
Id = integer()

No extra description in the original here either — just the types, fr fr. 🫶

create(This, Parent, Id, Options :: [Option]) -> boolean()

Types:

This = wxFontPickerCtrl()
Parent = wxWindow:wxWindow()
Id = integer()
Option =
    {initial, wxFont:wxFont()} |
    {pos, {X :: integer(), Y :: integer()}} |
    {size, {W :: integer(), H :: integer()}} |
    {style, integer()} |
    {validator, wx:wx_object()}

Creates this widget with given parameters.

Return: true if the control was successfully created or false if creation failed. ✅

getSelectedFont(This) -> wxFont:wxFont()

Types:

This = wxFontPickerCtrl()

Returns the currently selected font.

Note that this function is completely different from wxWindow:getFont/1. 🚨

setSelectedFont(This, Font) -> ok

Types:

This = wxFontPickerCtrl()
Font = wxFont:wxFont()

Sets the currently selected font.

Note that this function is completely different from wxWindow:setFont/2. 🚨

getMaxPointSize(This) -> integer()

Types:

This = wxFontPickerCtrl()

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

setMaxPointSize(This, Max) -> ok

Types:

This = wxFontPickerCtrl()
Max = integer()

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

The default value is 100. Also, 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 wxFNTP_USE_TEXTCTRL), it's a good idea to put a limit to the maximum font size when huge fonts do not make much sense. 🧠

destroy(This :: wxFontPickerCtrl()) -> ok

Destroys the object. 💥

---

Cute little footer sign-off: source/version vibes are wxWidgets team. and wx 2.2.2.1, and the manual tag is wxFontPickerCtrl(3erl). The original footer doesn’t give a separate date string, so I’m not inventing one — periodt. 💖🎀