#include <wx/font.h>

Inheritance diagram for wxFont:

Detailed Description

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, see wxDC::SetFont() and wxWindow::SetFont().

The easiest way to create a custom font is to use wxFontInfo object to specify the font attributes and then use wxFont::wxFont(const wxFontInfo&) constructor. Alternatively, you could start with one of the pre-defined fonts or use wxWindow::GetFont() and modify the font, e.g. by increasing its size using MakeLarger() or changing its weight using MakeBold().

This class uses reference counting and copy-on-write internally so that assignments between two instances of this class are very cheap. You can therefore use actual objects instead of pointers without efficiency problems. If an instance of this class is changed it will create its own data internally so that other instances, which previously shared the data using the reference counting, are not affected.

You can retrieve the current system font settings with wxSystemSettings.

Library: wxCore

Category: Graphics Device Interface (GDI)

Predefined objects/pointers: wxNullFont, wxNORMAL_FONT, wxSMALL_FONT, wxITALIC_FONT, wxSWISS_FONT

See Also: wxFont Overview, wxDC::SetFont, wxDC::DrawText, wxDC::GetTextExtent, wxFontDialog, wxSystemSettings

Public Member Functions
	wxFont ()
	Default ctor.

	wxFont (const wxFont &font)
	Copy constructor, uses reference counting.

	wxFont (const wxFontInfo &font)
	Creates a font object using the specified font description.

	wxFont (int pointSize, wxFontFamily family, wxFontStyle style, wxFontWeight weight, bool underline=false, const wxString &faceName=wxEmptyString, wxFontEncoding encoding=wxFONTENCODING_DEFAULT)
	Creates a font object with the specified attributes and size in points.

	wxFont (const wxSize &pixelSize, wxFontFamily family, wxFontStyle style, wxFontWeight weight, bool underline=false, const wxString &faceName=wxEmptyString, wxFontEncoding encoding=wxFONTENCODING_DEFAULT)
	Creates a font object with the specified attributes and size in pixels.

	wxFont (const wxString &nativeInfoString)
	Constructor from font description string.

	wxFont (const wxNativeFontInfo &nativeInfo)
	Construct font from a native font info structure.

virtual	~wxFont ()
	Destructor.

bool	operator!= (const wxFont &font) const
	Inequality operator.

bool	operator== (const wxFont &font) const
	Equality operator.

wxFont &	operator= (const wxFont &font)
	Assignment operator, using reference counting.

Getters
wxFont	GetBaseFont () const
	Returns a font with the same face/size as the given one but with normal weight and style and not underlined nor stricken through.

virtual wxFontEncoding	GetEncoding () const
	Returns the encoding of this font.

virtual wxString	GetFaceName () const
	Returns the face name associated with the font, or the empty string if there is no face information.

virtual wxFontFamily	GetFamily () const
	Gets the font family if possible.

wxString	GetNativeFontInfoDesc () const
	Returns the platform-dependent string completely describing this font.

wxString	GetNativeFontInfoUserDesc () const
	Returns a user-friendly string for this font object.

const wxNativeFontInfo *	GetNativeFontInfo () const
	Returns a font with the same face/size as the given one but with normal weight and style and not underlined nor stricken through.

virtual int	GetPointSize () const
	Gets the point size.

virtual wxSize	GetPixelSize () const
	Gets the pixel size.

virtual wxFontStyle	GetStyle () const
	Gets the font style.

virtual bool	GetUnderlined () const
	Returns true if the font is underlined, false otherwise.

virtual bool	GetStrikethrough () const
	Returns true if the font is stricken-through, false otherwise.

virtual wxFontWeight	GetWeight () const
	Gets the font weight.

virtual bool	IsFixedWidth () const
	Returns true if the font is a fixed width (or monospaced) font, false if it is a proportional one or font is invalid.

virtual bool	IsOk () const
	Returns true if this object is a valid font, false otherwise.

Similar fonts creation
The functions in this section either modify the font in place or create a new font similar to the given one but with its weight, style or size changed.
wxFont	Bold () const
	Returns a bold version of this font.

wxFont	Italic () const
	Returns an italic version of this font.

wxFont	Larger () const
	Returns a larger version of this font.

wxFont	Smaller () const
	Returns a smaller version of this font.

wxFont	Underlined () const
	Returns underlined version of this font.

wxFont	Strikethrough () const
	Returns stricken-through version of this font.

wxFont &	MakeBold ()
	Changes this font to be bold.

wxFont &	MakeItalic ()
	Changes this font to be italic.

wxFont &	MakeLarger ()
	Changes this font to be larger.

wxFont &	MakeSmaller ()
	Changes this font to be smaller.

wxFont &	MakeUnderlined ()
	Changes this font to be underlined.

wxFont &	MakeStrikethrough ()
	Changes this font to be stricken-through.

wxFont &	Scale (float x)
	Changes the size of this font.

wxFont	Scaled (float x) const
	Returns a scaled version of this font.

Setters
These functions internally recreate the native font object with the new specified property.
virtual void	SetEncoding (wxFontEncoding encoding)
	Sets the encoding for this font.

virtual bool	SetFaceName (const wxString &faceName)
	Sets the facename for the font.

virtual void	SetFamily (wxFontFamily family)
	Sets the font family.

bool	SetNativeFontInfo (const wxString &info)
	Creates the font corresponding to the given native font description string which must have been previously returned by GetNativeFontInfoDesc().

bool	SetNativeFontInfoUserDesc (const wxString &info)
	Creates the font corresponding to the given native font description string and returns true if the creation was successful.

void	SetNativeFontInfo (const wxNativeFontInfo &info)
	Sets the encoding for this font.

virtual void	SetPointSize (int pointSize)
	Sets the point size.

virtual void	SetPixelSize (const wxSize &pixelSize)
	Sets the pixel size.

virtual void	SetStyle (wxFontStyle style)
	Sets the font style.

void	SetSymbolicSize (wxFontSymbolicSize size)
	Sets the font size using a predefined symbolic size name.

void	SetSymbolicSizeRelativeTo (wxFontSymbolicSize size, int base)
	Sets the font size compared to the base font size.

virtual void	SetUnderlined (bool underlined)
	Sets underlining.

virtual void	SetStrikethrough (bool strikethrough)
	Sets strike-through attribute of the font.

virtual void	SetWeight (wxFontWeight weight)
	Sets the font weight.

Public Member Functions inherited from wxGDIObject
	wxGDIObject ()
	Default constructor.

Public Member Functions inherited from wxObject
	wxObject ()
	Default ctor; initializes to NULL the internal reference data.

	wxObject (const wxObject &other)
	Copy ctor.

virtual	~wxObject ()
	Destructor.

virtual wxClassInfo *	GetClassInfo () const
	This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar).

wxObjectRefData *	GetRefData () const
	Returns the wxObject::m_refData pointer, i.e. the data referenced by this object.

bool	IsKindOf (const wxClassInfo *info) const
	Determines whether this class is a subclass of (or the same class as) the given class.

bool	IsSameAs (const wxObject &obj) const
	Returns true if this object has the same data pointer as obj.

void	Ref (const wxObject &clone)
	Makes this object refer to the data in clone.

void	SetRefData (wxObjectRefData *data)
	Sets the wxObject::m_refData pointer.

void	UnRef ()
	Decrements the reference count in the associated data, and if it is zero, deletes the data.

void	UnShare ()
	This is the same of AllocExclusive() but this method is public.

void	operator delete (void *buf)
	The delete operator is defined for debugging versions of the library only, when the identifier `WXDEBUG` is defined.

void *	operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
	The new operator is defined for debugging versions of the library only, when the identifier `WXDEBUG` is defined.

Static Public Member Functions
static wxFontEncoding	GetDefaultEncoding ()
	Returns the current application's default encoding.

static void	SetDefaultEncoding (wxFontEncoding encoding)
	Sets the default font encoding.


static wxFont *	New (int pointSize, wxFontFamily family, wxFontStyle style, wxFontWeight weight, bool underline=false, const wxString &faceName=wxEmptyString, wxFontEncoding encoding=wxFONTENCODING_DEFAULT)
	This function takes the same parameters as the relative wxFont constructor and returns a new font object allocated on the heap.

static wxFont *	New (int pointSize, wxFontFamily family, int flags=wxFONTFLAG_DEFAULT, const wxString &faceName=wxEmptyString, wxFontEncoding encoding=wxFONTENCODING_DEFAULT)
	This function takes the same parameters as the relative wxFont constructor and returns a new font object allocated on the heap.

static wxFont *	New (const wxSize &pixelSize, wxFontFamily family, wxFontStyle style, wxFontWeight weight, bool underline=false, const wxString &faceName=wxEmptyString, wxFontEncoding encoding=wxFONTENCODING_DEFAULT)
	This function takes the same parameters as the relative wxFont constructor and returns a new font object allocated on the heap.

static wxFont *	New (const wxSize &pixelSize, wxFontFamily family, int flags=wxFONTFLAG_DEFAULT, const wxString &faceName=wxEmptyString, wxFontEncoding encoding=wxFONTENCODING_DEFAULT)
	This function takes the same parameters as the relative wxFont constructor and returns a new font object allocated on the heap.

static wxFont *	New (const wxNativeFontInfo &nativeInfo)
	This function takes the same parameters as the relative wxFont constructor and returns a new font object allocated on the heap.

static wxFont *	New (const wxString &nativeInfoString)
	This function takes the same parameters as the relative wxFont constructor and returns a new font object allocated on the heap.

Additional Inherited Members
Protected Member Functions inherited from wxObject
void	AllocExclusive ()
	Ensure that this object's data is not shared with any other object.

virtual wxObjectRefData *	CreateRefData () const
	Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it.

virtual wxObjectRefData *	CloneRefData (const wxObjectRefData *data) const
	Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data.

Protected Attributes inherited from wxObject
wxObjectRefData *	m_refData
	Pointer to an object which is the object's reference-counted data.

Constructor & Destructor Documentation

wxFont::wxFont ( )

Default ctor.

wxFont::wxFont ( const wxFont & font )

Copy constructor, uses reference counting.

wxFont::wxFont ( const wxFontInfo & font )

Creates a font object using the specified font description.

This is the preferred way to create font objects as using this ctor results in more readable code and it is also extensible, e.g. it could continue to be used if support for more font attributes is added in the future. For example, this constructor provides the only way of creating fonts with strike-through style.

Example of creating a font using this ctor:

wxFont font(wxFontInfo(10).Bold().Underlined());

Since: 2.9.5

wxFont::wxFont	(	int	pointSize,
		wxFontFamily	family,
		wxFontStyle	style,
		wxFontWeight	weight,
		bool	underline = `false`,
		const wxString &	faceName = `wxEmptyString`,
		wxFontEncoding	encoding = `wxFONTENCODING_DEFAULT`
	)

Creates a font object with the specified attributes and size in points.

Notice that the use of this constructor is often more verbose and less readable than the use of constructor from wxFontInfo, e.g. the example in that constructor documentation would need to be written as

wxFont font(10, wxFONTFAMILY_DEFAULT, wxFONTSTYLE_NORMAL,

wxFONTWEIGHT_BOLD, true);

which is longer and less clear.

Parameters

pointSize Size in points. See SetPointSize() for more info.

family The font family: a generic portable way of referring to fonts without specifying a facename. This parameter must be one of the wxFontFamily enumeration values. If the faceName argument is provided, then it overrides the font family.

style One of wxFONTSTYLE_NORMAL, wxFONTSTYLE_SLANT and wxFONTSTYLE_ITALIC.

weight Font weight, sometimes also referred to as font boldness. One of the wxFontWeight enumeration values.

underline The value can be true or false. At present this has an effect on Windows and Motif 2.x only.

faceName An optional string specifying the face name to be used. If it is an empty string, a default face name will be chosen based on the family.

encoding

An encoding which may be one of the enumeration values of wxFontEncoding. Briefly these can be summed up as:

`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 (see also Font Encodings).

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

wxFont::wxFont	(	const wxSize &	pixelSize,
		wxFontFamily	family,
		wxFontStyle	style,
		wxFontWeight	weight,
		bool	underline = `false`,
		const wxString &	faceName = `wxEmptyString`,
		wxFontEncoding	encoding = `wxFONTENCODING_DEFAULT`
	)

Creates a font object with the specified attributes and size in pixels.

Notice that the use of this constructor is often more verbose and less readable than the use of constructor from wxFontInfo, consider using that constructor instead.

Parameters

pixelSize Size in pixels. See SetPixelSize() for more info.

family The font family: a generic portable way of referring to fonts without specifying a facename. This parameter must be one of the wxFontFamily enumeration values. If the faceName argument is provided, then it overrides the font family.

style One of wxFONTSTYLE_NORMAL, wxFONTSTYLE_SLANT and wxFONTSTYLE_ITALIC.

weight Font weight, sometimes also referred to as font boldness. One of the wxFontWeight enumeration values.

underline The value can be true or false. At present this has an effect on Windows and Motif 2.x only.

faceName An optional string specifying the face name to be used. If it is an empty string, a default face name will be chosen based on the family.

encoding

An encoding which may be one of the enumeration values of wxFontEncoding. Briefly these can be summed up as:

`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 (see also Font Encodings).

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

wxFont::wxFont ( const wxString & nativeInfoString )

Constructor from font description string.

This constructor uses SetNativeFontInfo() to initialize the font. If fontdesc is invalid the font remains uninitialized, i.e. its IsOk() method will return false.

wxFont::wxFont ( const wxNativeFontInfo & nativeInfo )

Construct font from a native font info structure.

virtual wxFont::~wxFont ( )

virtual

Destructor.

See reference-counted object destruction for more info.

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

Member Function Documentation

wxFont wxFont::Bold ( ) const

Returns a bold version of this font.

See Also: MakeBold()

Since: 2.9.1

wxFont wxFont::GetBaseFont ( ) const

Returns a font with the same face/size as the given one but with normal weight and style and not underlined nor stricken through.

Since: 3.1.0

static wxFontEncoding wxFont::GetDefaultEncoding ( )

static

Returns the current application's default encoding.

See Also: Font Encodings, SetDefaultEncoding()

virtual wxFontEncoding wxFont::GetEncoding ( ) const

virtual

Returns the encoding of this font.

Note that under wxGTK the returned value is always wxFONTENCODING_UTF8.

See Also: SetEncoding()

virtual wxString wxFont::GetFaceName ( ) const

virtual

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

See Also: SetFaceName()

virtual wxFontFamily wxFont::GetFamily ( ) const

virtual

Gets the font family if possible.

As described in wxFontFamily docs the returned value acts as a rough, basic classification of the main font properties (look, spacing).

If the current font face name is not recognized by wxFont or by the underlying system, wxFONTFAMILY_DEFAULT is returned.

Note that currently this function is not very precise and so not particularly useful. Font families mostly make sense only for font creation, see SetFamily().

See Also: SetFamily()

const wxNativeFontInfo* wxFont::GetNativeFontInfo ( ) const

Returns a font with the same face/size as the given one but with normal weight and style and not underlined nor stricken through.

Since: 3.1.0

wxString wxFont::GetNativeFontInfoDesc ( ) const

Returns the platform-dependent string completely describing this font.

Returned string is always non-empty unless the font is invalid (in which case an assert is triggered).

Note that the returned string is not meant to be shown or edited by the user: a typical use of this function is for serializing in string-form a wxFont object.

See Also: SetNativeFontInfo(), GetNativeFontInfoUserDesc()

wxString wxFont::GetNativeFontInfoUserDesc ( ) const

Returns a user-friendly string for this font object.

Returned string is always non-empty unless the font is invalid (in which case an assert is triggered).

The string does not encode all wxFont infos under all platforms; e.g. under wxMSW the font family is not present in the returned string.

Some examples of the formats of returned strings (which are platform-dependent) are in SetNativeFontInfoUserDesc().

See Also: SetNativeFontInfoUserDesc(), GetNativeFontInfoDesc()

virtual wxSize wxFont::GetPixelSize ( ) const

virtual

Gets the pixel size.

Note that under wxMSW if you passed to SetPixelSize() (or to the ctor) a wxSize object with a null width value, you'll get a null width in the returned object.

See Also: SetPixelSize()

virtual int wxFont::GetPointSize ( ) const

virtual

Gets the point size.

See Also: SetPointSize()

virtual bool wxFont::GetStrikethrough ( ) const

virtual

Returns true if the font is stricken-through, false otherwise.

See Also: SetStrikethrough()

Since: 2.9.4

virtual wxFontStyle wxFont::GetStyle ( ) const

virtual

Gets the font style.

See wxFontStyle for a list of valid styles.

See Also: SetStyle()

virtual bool wxFont::GetUnderlined ( ) const

virtual

Returns true if the font is underlined, false otherwise.

See Also: SetUnderlined()

virtual wxFontWeight wxFont::GetWeight ( ) const

virtual

Gets the font weight.

See wxFontWeight for a list of valid weight identifiers.

See Also: SetWeight()

virtual bool wxFont::IsFixedWidth ( ) const

virtual

Returns true if the font is a fixed width (or monospaced) font, false if it is a proportional one or font is invalid.

Note that this function under some platforms is different than just testing for the font family being equal to wxFONTFAMILY_TELETYPE because native platform-specific functions are used for the check (resulting in a more accurate return value).

virtual bool wxFont::IsOk ( ) const

virtual

Returns true if this object is a valid font, false otherwise.

wxFont wxFont::Italic ( ) const

Returns an italic version of this font.

See Also: MakeItalic()

Since: 2.9.1

wxFont wxFont::Larger ( ) const

Returns a larger version of this font.

The font size is multiplied by 1.2, the factor of 1.2 being inspired by the W3C CSS specification.

See Also: MakeLarger(), Smaller(), Scaled()

Since: 2.9.1

wxFont& wxFont::MakeBold ( )

Changes this font to be bold.

See Also: Bold()

Since: 2.9.1

wxFont& wxFont::MakeItalic ( )

Changes this font to be italic.

See Also: Italic()

Since: 2.9.1

wxFont& wxFont::MakeLarger ( )

Changes this font to be larger.

The font size is multiplied by 1.2, the factor of 1.2 being inspired by the W3C CSS specification.

See Also: Larger(), MakeSmaller(), Scale()

Since: 2.9.1

wxFont& wxFont::MakeSmaller ( )

Changes this font to be smaller.

The font size is divided by 1.2, the factor of 1.2 being inspired by the W3C CSS specification.

See Also: Smaller(), MakeLarger(), Scale()

Since: 2.9.1

wxFont& wxFont::MakeStrikethrough ( )

Changes this font to be stricken-through.

Currently stricken-through fonts are only supported in wxMSW and wxGTK.

See Also: Strikethrough()

Since: 2.9.4

wxFont& wxFont::MakeUnderlined ( )

Changes this font to be underlined.

See Also: Underlined()

Since: 2.9.2

static wxFont* wxFont::New	(	int	pointSize,
		wxFontFamily	family,
		wxFontStyle	style,
		wxFontWeight	weight,
		bool	underline = `false`,
		const wxString &	faceName = `wxEmptyString`,
		wxFontEncoding	encoding = `wxFONTENCODING_DEFAULT`
	)

static

This function takes the same parameters as the relative wxFont constructor and returns a new font object allocated on the heap.