## wxFont

A font is an object which determines the appearance of text. Fonts are used for drawing text to a device context, and setting the appearance of a window's text.

Derived from

wxGDIObject
wxObject

Include files

<wx/font.h>

Predefined objects

Objects:

wxNullFont

Pointers:

wxNORMAL_FONT
wxSMALL_FONT
wxITALIC_FONT
wxSWISS_FONT

See also

wxFont overview, wxDC::SetFont, wxDC::DrawText, wxDC::GetTextExtent, wxFontDialog

Members

wxFont::wxFont
wxFont::~wxFont
wxFont::GetDefaultEncoding
wxFont::GetFaceName
wxFont::GetFamily
wxFont::GetFontId
wxFont::GetPointSize
wxFont::GetStyle
wxFont::GetUnderlined
wxFont::GetWeight
wxFont::SetDefaultEncoding
wxFont::SetFaceName
wxFont::SetFamily
wxFont::SetPointSize
wxFont::SetStyle
wxFont::SetUnderlined
wxFont::SetWeight
wxFont::operator =
wxFont::operator ==
wxFont::operator !=

### wxFont::wxFont

wxFont()

Default constructor.

wxFont(int pointSize, int family, int style, int weight, const bool underline = FALSE, const wxString& faceName = "", wxFontEncoding encoding = wxFONTENCODING_DEFAULT)

Creates a font object (see font encoding overview for the meaning of the last parameter).

Parameters

pointSize

Size in points.

family

Font family, a generic way of referring to fonts without specifying actual facename. One of:

wxDEFAULT | Chooses a default font.
wxDECORATIVE | A decorative font.
wxROMAN | A formal, serif font.
wxSCRIPT | A handwriting font.
wxSWISS | A sans-serif font.
wxMODERN | A fixed pitch font.

style

One of wxNORMAL, wxSLANT and wxITALIC.

weight

One of wxNORMAL, wxLIGHT and wxBOLD.

underline

The value can be TRUE or FALSE. At present this has an effect on Windows only.

faceName

An optional string specifying the actual typeface to be used. If the empty string, a default typeface will chosen based on the family.

encoding

An encoding which may be one of

wxFONTENCODING_SYSTEM | Default system encoding.
wxFONTENCODING_DEFAULT | Default application encoding: this is the encoding set by calls to SetDefaultEncoding and which may be set to, say, KOI8 to create all fonts by default with KOI8 encoding. Initially, the default application encoding is the same as default system encoding.
wxFONTENCODING_ISO8859_1...15 | ISO8859 encodings.
wxFONTENCODING_KOI8 | The standard russian encoding for Internet.
wxFONTENCODING_CP1250...1252 | Windows encodings similar to ISO8859 (but not identical).

If the specified encoding isn't available, no font is created.

Remarks

If the desired font does not exist, the closest match will be chosen. Under Windows, only scaleable TrueType fonts are used.

Underlining only works under Windows at present.

See also wxDC::SetFont, wxDC::DrawText and wxDC::GetTextExtent.

### wxFont::~wxFont

~wxFont()

Destructor.

Remarks

The destructor may not delete the underlying font object of the native windowing system, since wxFont uses a reference counting system for efficiency.

Although all remaining fonts are deleted when the application exits, the application should try to clean up all fonts itself. This is because wxWindows cannot know if a pointer to the font object is stored in an application data structure, and there is a risk of double deletion.

### wxFont::GetDefaultEncoding

static wxFontEncoding GetDefaultEncoding()

Returns the current applications default encoding.

See also

Font encoding overview, SetDefaultEncoding

### wxFont::GetFaceName

wxString GetFaceName() const

Returns the typeface name associated with the font, or the empty string if there is no typeface information.

See also

wxFont::SetFaceName

### wxFont::GetFamily

int GetFamily() const

Gets the font family. See wxFont::wxFont for a list of valid family identifiers.

See also

wxFont::SetFamily

### wxFont::GetFontId

int GetFontId() const

Returns the font id, if the portable font system is in operation. See Font overview for further details.

### wxFont::GetPointSize

int GetPointSize() const

Gets the point size.

See also

wxFont::SetPointSize

### wxFont::GetStyle

int GetStyle() const

Gets the font style. See wxFont::wxFont for a list of valid styles.

See also

wxFont::SetStyle

### wxFont::GetUnderlined

bool GetUnderlined() const

Returns TRUE if the font is underlined, FALSE otherwise.

See also

wxFont::SetUnderlined

### wxFont::GetWeight

int GetWeight() const

Gets the font weight. See wxFont::wxFont for a list of valid weight identifiers.

See also

wxFont::SetWeight

### wxFont::SetDefaultEncoding

static void SetDefaultEncoding(wxFontEncoding encoding)

Sets the default font encoding.

See also

Font encoding overview, GetDefaultEncoding

### wxFont::SetFaceName

void SetFaceName(const wxString& faceName)

Sets the facename for the font.

Parameters

faceName

A valid facename, which should be on the end-user's system.

Remarks

To avoid portability problems, don't rely on a specific face, but specify the font family instead or as well. A suitable font will be found on the end-user's system. If both the family and the facename are specified, wxWindows will first search for the specific face, and then for a font belonging to the same family.

See also

wxFont::GetFaceName, wxFont::SetFamily

### wxFont::SetFamily

void SetFamily(int family)

Sets the font family.

Parameters

family

One of:

wxDEFAULT | Chooses a default font.
wxDECORATIVE | A decorative font.
wxROMAN | A formal, serif font.
wxSCRIPT | A handwriting font.
wxSWISS | A sans-serif font.
wxMODERN | A fixed pitch font.

See also

wxFont::GetFamily, wxFont::SetFaceName

### wxFont::SetPointSize

void SetPointSize(int pointSize)

Sets the point size.

Parameters

pointSize

Size in points.

See also

wxFont::GetPointSize

### wxFont::SetStyle

void SetStyle(int style)

Sets the font style.

Parameters

style

One of wxNORMAL, wxSLANT and wxITALIC.

See also

wxFont::GetStyle

### wxFont::SetUnderlined

void SetUnderlined(const bool underlined)

Sets underlining.

Parameters

underlining

TRUE to underline, FALSE otherwise.

See also

wxFont::GetUnderlined

### wxFont::SetWeight

void SetWeight(int weight)

Sets the font weight.

Parameters

weight

One of wxNORMAL, wxLIGHT and wxBOLD.

See also

wxFont::GetWeight

### wxFont::operator =

wxFont& operator =(const wxFont& font)

Assignment operator, using reference counting. Returns a reference to 'this'.

### wxFont::operator ==

bool operator ==(const wxFont& font)

Equality operator. Two fonts are equal if they contain pointers to the same underlying font data. It does not compare each attribute, so two indefontdently-created fonts using the same parameters will fail the test.

### wxFont::operator !=

bool operator !=(const wxFont& font)

Inequality operator. Two fonts are not equal if they contain pointers to different underlying font data. It does not compare each attribute.