wxFontData(3erl)

πŸŽ€ NAME πŸŽ€

Okay so this is the manual page for wxFontData, manual-page name wxFontData, straight outta the Erlang Module Definition zone β€” and it is literally all about functions for the wxFontData class. Bestie, we’re learning the font-dialog data object and it’s giving main character energy. πŸ’…βœ¨


✨ DESCRIPTION ✨

This class holds a variety of information related to font dialogs. So wxFontData is the cute little info-holder for font-dialog stuff β€” a whole variety of information related to font dialogs lives here, no cap. 🫢

See: Overview cmndlg, wxFont, wxFontDialog β€” go peek, iykyk. πŸ‘‘

wxWidgets docs: wxFontData


πŸ¦‹ DATA TYPES πŸ¦‹

One data type, periodt:

wxFontData() = wx:wx_object()

πŸ’… EXPORTS πŸ’…

Every single export is here, bestie β€” no skips, no crumbs. 🌸

🌈 new() -> wxFontData() 🌈

Constructor. It’s giving β€œmake a fresh one,” and we love that for us. πŸŽ€

Initializes fontColour to black, showHelp to false, allowSymbols to true, enableEffects to true, minSize to 0 and maxSize to 0.

🌈 new(Data) -> wxFontData() 🌈

Types:

Data = wxFontData()

Copy Constructor. Literally copy-constructor energy β€” it copies the data, periodt. 🫢

🌈 enableEffects(This, Enable) -> ok 🌈

Types:

This = wxFontData()
Enable = boolean()

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.

🌈 getAllowSymbols(This) -> boolean() 🌈

Types:

This = wxFontData()

Under Windows, returns a flag determining whether symbol fonts can be selected. πŸ”₯

Has no effect on other platforms.

The default value is true.

🌈 getColour(This) -> wx:wx_colour4() 🌈

Types:

This = wxFontData()

Gets the colour associated with the font dialog. πŸ’–

The default value is black.

🌈 getChosenFont(This) -> wxFont:wxFont() 🌈

Types:

This = wxFontData()

Gets the font chosen by the user if the user pressed OK β€” specifically when wxFontDialog::ShowModal() (not implemented in wx) returned wxID_OK. Slay. πŸ‘‘

🌈 getEnableEffects(This) -> boolean() 🌈

Types:

This = wxFontData()

Determines whether "effects" are enabled under Windows. πŸ¦‹

This refers to the controls for manipulating colour, strikeout and underline properties.

The default value is true.

🌈 getInitialFont(This) -> wxFont:wxFont() 🌈

Types:

This = wxFontData()

Gets the font that will be initially used by the font dialog. ✨

This should have previously been set by the application.

🌈 getShowHelp(This) -> boolean() 🌈

Types:

This = wxFontData()

Returns true if the Help button will be shown (Windows only). πŸ™ˆ

The default value is false.

🌈 setAllowSymbols(This, AllowSymbols) -> ok 🌈

Types:

This = wxFontData()
AllowSymbols = boolean()

Under Windows, determines whether symbol fonts can be selected. 🌟

Has no effect on other platforms.

The default value is true.

🌈 setChosenFont(This, Font) -> ok 🌈

Types:

This = wxFontData()
Font = wxFont:wxFont()

Sets the font that will be returned to the user (for internal use only). πŸ’…

🌈 setColour(This, Colour) -> ok 🌈

Types:

This = wxFontData()
Colour = wx:wx_colour()

Sets the colour that will be used for the font foreground colour. 🎨

The default colour is black.

🌈 setInitialFont(This, Font) -> ok 🌈

Types:

This = wxFontData()
Font = wxFont:wxFont()

Sets the font that will be initially used by the font dialog. 🌸

🌈 setRange(This, Min, Max) -> ok 🌈

Types:

This = wxFontData()
Min = Max = integer()

Sets the valid range for the font point size (Windows only). πŸ”’

The default is 0, 0 (unrestricted range).

🌈 setShowHelp(This, ShowHelp) -> ok 🌈

Types:

This = wxFontData()
ShowHelp = boolean()

Determines whether the Help button will be displayed in the font dialog (Windows only). πŸ’–

The default value is false.

🌈 destroy(This :: wxFontData()) -> ok 🌈

Destroys the object. Bye bestie, iconic exit. πŸ’€βœ¨


Cute sign-off: source/version is the wxWidgets team with wx 2.2.2.1, and the page is wxFontData(3erl) β€” the date isn’t printed in this footer, so no fake date, periodt. πŸ«ΆπŸ’œπŸŒˆ

πŸ“¦ where this page comes from