wxFontData — wx v2.4.2

Search documentation of wx

# View Source wxFontData (wx v2.4.2)

Functions for wxFontData class

This class holds a variety of information related to font dialogs.

See: Overview cmndlg, `wxFont`, `wxFontDialog`

wxWidgets docs: wxFontData

# Summary

## Types

wxFontData()

## Functions

destroy(This)

Destroys the object.

enableEffects(This, Enable)

Enables or disables "effects" under Windows or generic only.

getAllowSymbols(This)

Under Windows, returns a flag determining whether symbol fonts can be selected.

getChosenFont(This)

Gets the font chosen by the user if the user pressed OK (`wxFontDialog::ShowModal()` (not implemented in wx) returned wxID_OK).

getColour(This)

Gets the colour associated with the font dialog.

getEnableEffects(This)

Determines whether "effects" are enabled under Windows.

getInitialFont(This)

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

getShowHelp(This)

Returns true if the Help button will be shown (Windows only).

new()

Constructor.

new(Data)

Copy Constructor.

setAllowSymbols(This, AllowSymbols)

Under Windows, determines whether symbol fonts can be selected.

setChosenFont(This, Font)

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

setColour(This, Colour)

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

setInitialFont(This, Font)

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

setRange(This, Min, Max)

Sets the valid range for the font point size (Windows only).

setShowHelp(This, ShowHelp)

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

# Types

Link to this type

# wxFontData()

View Source

    -type wxFontData() :: wx:wx_object().

# Functions

Link to this function

# destroy(This)

View Source

    -spec destroy(This :: wxFontData()) -> ok.

Destroys the object.

Link to this function

# enableEffects(This, Enable)

View Source

    -spec enableEffects(This, Enable) -> ok when 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.

Link to this function

# getAllowSymbols(This)

View Source

    -spec getAllowSymbols(This) -> boolean() when 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.

Link to this function

# getChosenFont(This)

View Source

    -spec getChosenFont(This) -> wxFont:wxFont() when This :: wxFontData().

Gets the font chosen by the user if the user pressed OK (`wxFontDialog::ShowModal()` (not implemented in wx) returned wxID_OK).

Link to this function

# getColour(This)

View Source

    -spec getColour(This) -> wx:wx_colour4() when This :: wxFontData().

Gets the colour associated with the font dialog.

The default value is black.

Link to this function

# getEnableEffects(This)

View Source

    -spec getEnableEffects(This) -> boolean() when 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.

Link to this function

# getInitialFont(This)

View Source

    -spec getInitialFont(This) -> wxFont:wxFont() when This :: wxFontData().

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

This should have previously been set by the application.

Link to this function

# getShowHelp(This)

View Source

    -spec getShowHelp(This) -> boolean() when This :: wxFontData().

Returns true if the Help button will be shown (Windows only).

The default value is false.

Link to this function

# new()

View Source

    -spec new() -> wxFontData().

Constructor.

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

Link to this function

# new(Data)

View Source

    -spec new(Data) -> wxFontData() when Data :: wxFontData().

Copy Constructor.

Link to this function

# setAllowSymbols(This, AllowSymbols)

View Source

    -spec setAllowSymbols(This, AllowSymbols) -> ok when This :: wxFontData(), AllowSymbols :: boolean().

Under Windows, determines whether symbol fonts can be selected.

Has no effect on other platforms.

The default value is true.

Link to this function

# setChosenFont(This, Font)

View Source

    -spec setChosenFont(This, Font) -> ok when This :: wxFontData(), Font :: wxFont:wxFont().

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

Link to this function

# setColour(This, Colour)

View Source

    -spec setColour(This, Colour) -> ok when This :: wxFontData(), Colour :: wx:wx_colour().

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

The default colour is black.

Link to this function

# setInitialFont(This, Font)

View Source

    -spec setInitialFont(This, Font) -> ok when This :: wxFontData(), Font :: wxFont:wxFont().

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

Link to this function

# setRange(This, Min, Max)

View Source

    -spec setRange(This, Min, Max) -> ok when This :: wxFontData(), Min :: integer(), Max :: integer().

Sets the valid range for the font point size (Windows only).

The default is 0, 0 (unrestricted range).

Link to this function

# setShowHelp(This, ShowHelp)

View Source

    -spec setShowHelp(This, ShowHelp) -> ok when This :: wxFontData(), ShowHelp :: boolean().

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

The default value is false.