Version: 3.1.1

#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

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. More...
 
virtual wxFontEncoding GetEncoding () const
 Returns the encoding of this font. More...
 
virtual wxString GetFaceName () const
 Returns the face name associated with the font, or the empty string if there is no face information. More...
 
virtual wxFontFamily GetFamily () const
 Gets the font family if possible. More...
 
wxString GetNativeFontInfoDesc () const
 Returns the platform-dependent string completely describing this font. More...
 
wxString GetNativeFontInfoUserDesc () const
 Returns a user-friendly string for this font object. More...
 
const wxNativeFontInfoGetNativeFontInfo () 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. More...
 
virtual int GetPointSize () const
 Gets the point size. More...
 
virtual wxSize GetPixelSize () const
 Gets the pixel size. More...
 
virtual wxFontStyle GetStyle () const
 Gets the font style. More...
 
virtual bool GetUnderlined () const
 Returns true if the font is underlined, false otherwise. More...
 
virtual bool GetStrikethrough () const
 Returns true if the font is stricken-through, false otherwise. More...
 
virtual wxFontWeight GetWeight () const
 Gets the font weight. More...
 
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. More...
 
virtual bool IsOk () const
 Returns true if this object is a valid font, false otherwise. More...
 
static bool AddPrivateFont (const wxString &filename)
 Specify the name of a file containing a TrueType font to be made available to the current application. More...
 

Public Member Functions

 wxFont ()
 Default ctor. More...
 
 wxFont (const wxFont &font)
 Copy constructor, uses reference counting. More...
 
 wxFont (const wxFontInfo &fontInfo)
 Creates a font object using the specified font description. More...
 
 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. More...
 
 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. More...
 
 wxFont (const wxString &nativeInfoString)
 Constructor from font description string. More...
 
 wxFont (const wxNativeFontInfo &nativeInfo)
 Construct font from a native font info structure. More...
 
virtual ~wxFont ()
 Destructor. More...
 
bool operator!= (const wxFont &font) const
 Inequality operator. More...
 
bool operator== (const wxFont &font) const
 Equality operator. More...
 
wxFontoperator= (const wxFont &font)
 Assignment operator, using reference counting. More...
 
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. More...
 
wxFont Italic () const
 Returns an italic version of this font. More...
 
wxFont Larger () const
 Returns a larger version of this font. More...
 
wxFont Smaller () const
 Returns a smaller version of this font. More...
 
wxFont Underlined () const
 Returns underlined version of this font. More...
 
wxFont Strikethrough () const
 Returns stricken-through version of this font. More...
 
wxFontMakeBold ()
 Changes this font to be bold. More...
 
wxFontMakeItalic ()
 Changes this font to be italic. More...
 
wxFontMakeLarger ()
 Changes this font to be larger. More...
 
wxFontMakeSmaller ()
 Changes this font to be smaller. More...
 
wxFontMakeUnderlined ()
 Changes this font to be underlined. More...
 
wxFontMakeStrikethrough ()
 Changes this font to be stricken-through. More...
 
wxFontScale (float x)
 Changes the size of this font. More...
 
wxFont Scaled (float x) const
 Returns a scaled version of this font. More...
 
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. More...
 
virtual bool SetFaceName (const wxString &faceName)
 Sets the facename for the font. More...
 
virtual void SetFamily (wxFontFamily family)
 Sets the font family. More...
 
bool SetNativeFontInfo (const wxString &info)
 Creates the font corresponding to the given native font description string which must have been previously returned by GetNativeFontInfoDesc(). More...
 
bool SetNativeFontInfoUserDesc (const wxString &info)
 Creates the font corresponding to the given native font description string and returns true if the creation was successful. More...
 
void SetNativeFontInfo (const wxNativeFontInfo &info)
 Sets the encoding for this font. More...
 
virtual void SetPointSize (int pointSize)
 Sets the point size. More...
 
virtual void SetPixelSize (const wxSize &pixelSize)
 Sets the pixel size. More...
 
virtual void SetStyle (wxFontStyle style)
 Sets the font style. More...
 
void SetSymbolicSize (wxFontSymbolicSize size)
 Sets the font size using a predefined symbolic size name. More...
 
void SetSymbolicSizeRelativeTo (wxFontSymbolicSize size, int base)
 Sets the font size compared to the base font size. More...
 
virtual void SetUnderlined (bool underlined)
 Sets underlining. More...
 
virtual void SetStrikethrough (bool strikethrough)
 Sets strike-through attribute of the font. More...
 
virtual void SetWeight (wxFontWeight weight)
 Sets the font weight. More...
 
- Public Member Functions inherited from wxGDIObject
 wxGDIObject ()
 Default constructor. More...
 
- Public Member Functions inherited from wxObject
 wxObject ()
 Default ctor; initializes to NULL the internal reference data. More...
 
 wxObject (const wxObject &other)
 Copy ctor. More...
 
virtual ~wxObject ()
 Destructor. More...
 
virtual wxClassInfoGetClassInfo () const
 This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). More...
 
wxObjectRefDataGetRefData () const
 Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. More...
 
bool IsKindOf (const wxClassInfo *info) const
 Determines whether this class is a subclass of (or the same class as) the given class. More...
 
bool IsSameAs (const wxObject &obj) const
 Returns true if this object has the same data pointer as obj. More...
 
void Ref (const wxObject &clone)
 Makes this object refer to the data in clone. More...
 
void SetRefData (wxObjectRefData *data)
 Sets the wxObject::m_refData pointer. More...
 
void UnRef ()
 Decrements the reference count in the associated data, and if it is zero, deletes the data. More...
 
void UnShare ()
 This is the same of AllocExclusive() but this method is public. More...
 
void operator delete (void *buf)
 The delete operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
 
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. More...
 

Static Public Member Functions

static wxFontEncoding GetDefaultEncoding ()
 Returns the current application's default encoding. More...
 
static void SetDefaultEncoding (wxFontEncoding encoding)
 Sets the default font encoding. More...
 
static wxFontNew (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. More...
 
static wxFontNew (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. More...
 
static wxFontNew (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. More...
 
static wxFontNew (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. More...
 
static wxFontNew (const wxNativeFontInfo &nativeInfo)
 This function takes the same parameters as the relative wxFont constructor and returns a new font object allocated on the heap. More...
 
static wxFontNew (const wxString &nativeInfoString)
 This function takes the same parameters as the relative wxFont constructor and returns a new font object allocated on the heap. More...
 

Additional Inherited Members

- Protected Member Functions inherited from wxObject
void AllocExclusive ()
 Ensure that this object's data is not shared with any other object. More...
 
virtual wxObjectRefDataCreateRefData () const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. More...
 
virtual wxObjectRefDataCloneRefData (const wxObjectRefData *data) const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data. More...
 
- Protected Attributes inherited from wxObject
wxObjectRefDatam_refData
 Pointer to an object which is the object's reference-counted data. More...
 

Constructor & Destructor Documentation

wxFont::wxFont ( )

Default ctor.

wxFont::wxFont ( const wxFont font)

Copy constructor, uses reference counting.

wxFont::wxFont ( const wxFontInfo fontInfo)

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:

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 using wxFont(const wxFontInfo& font), e.g. the example in that constructor documentation would need to be written as:

Parameters
pointSizeSize in points. See SetPointSize() for more info. Notice that, for historical reasons, the value 70 here is interpreted at wxDEFAULT and results in creation of the font with the default size and not of a font with the size of 70pt. If you really need the latter, please use SetPointSize(70).
familyThe 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.
styleOne of wxFONTSTYLE_NORMAL, wxFONTSTYLE_SLANT and wxFONTSTYLE_ITALIC.
weightFont weight, sometimes also referred to as font boldness. One of the wxFontWeight enumeration values.
underlineThe value can be true or false. At present this has an effect on Windows and Motif 2.x only.
faceNameAn 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.
encodingAn encoding which may be one of the enumeration values of wxFontEncoding. 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
pixelSizeSize in pixels. See SetPixelSize() for more info.
familyThe 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.
styleOne of wxFONTSTYLE_NORMAL, wxFONTSTYLE_SLANT and wxFONTSTYLE_ITALIC.
weightFont weight, sometimes also referred to as font boldness. One of the wxFontWeight enumeration values.
underlineThe value can be true or false. At present this has an effect on Windows and Motif 2.x only.
faceNameAn 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.
encodingAn encoding which may be one of the enumeration values of wxFontEncoding. 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

static bool wxFont::AddPrivateFont ( const wxString filename)
static

Specify the name of a file containing a TrueType font to be made available to the current application.

This method can be used to allow this application to use the font from the given file even if it is not globally installed on the system.

Under OS X this method actually doesn't do anything other than check for the existence of the file in the "Fonts" subdirectory of the application bundle "Resources" directory. You are responsible for actually making the font file available in this directory and setting ATSApplicationFontsPath to Fonts value in your Info.plist file. See also wxStandardPaths::GetResourcesDir().

Under MSW this method must be called before any wxGraphicsContext objects have been created, otherwise the private font won't be usable from them.

Under Unix this method requires Pango 1.38 or later and will return false and log an error message explaining the problem if this requirement is not satisfied either at compile- or run-time.

Currently this method is implemented for all major platforms (subject to having Pango 1.38 or later when running configure under Unix) and wxUSE_PRIVATE_FONTS is always set to 0 under the other platforms, making this function unavailable at compile-time.

Returns
true if the font was added and can now be used.
Since
3.1.1
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, wxGTK, and wxOSX.

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.

Their use is discouraged, use wxFont constructor from wxFontInfo instead.

static wxFont* wxFont::New ( int  pointSize,
wxFontFamily  family,
int  flags = wxFONTFLAG_DEFAULT,
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.

Their use is discouraged, use wxFont constructor from wxFontInfo instead.

static wxFont* wxFont::New ( const wxSize pixelSize,
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.

Their use is discouraged, use wxFont constructor from wxFontInfo instead.

static wxFont* wxFont::New ( const wxSize pixelSize,
wxFontFamily  family,
int  flags = wxFONTFLAG_DEFAULT,
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.

Their use is discouraged, use wxFont constructor from wxFontInfo instead.

static wxFont* wxFont::New ( const wxNativeFontInfo nativeInfo)
static

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

Their use is discouraged, use wxFont constructor from wxFontInfo instead.

static wxFont* wxFont::New ( const wxString nativeInfoString)
static

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

Their use is discouraged, use wxFont constructor from wxFontInfo instead.

bool wxFont::operator!= ( const wxFont font) const

Inequality operator.

See reference-counted object comparison for more info.

wxFont& wxFont::operator= ( const wxFont font)

Assignment operator, using reference counting.

bool wxFont::operator== ( const wxFont font) const

Equality operator.

See reference-counted object comparison for more info.

wxFont& wxFont::Scale ( float  x)

Changes the size of this font.

The font size is multiplied by the given factor (which may be less than 1 to create a smaller version of the font).

See also
Scaled(), MakeLarger(), MakeSmaller()
Since
2.9.1
wxFont wxFont::Scaled ( float  x) const

Returns a scaled version of this font.

The font size is multiplied by the given factor (which may be less than 1 to create a smaller version of the font).

See also
Scale(), Larger(), Smaller()
Since
2.9.1
static void wxFont::SetDefaultEncoding ( wxFontEncoding  encoding)
static

Sets the default font encoding.

See also
Font Encodings, GetDefaultEncoding()
virtual void wxFont::SetEncoding ( wxFontEncoding  encoding)
virtual

Sets the encoding for this font.

Note that under wxGTK this function has no effect (because the underlying Pango library always uses wxFONTENCODING_UTF8).

See also
GetEncoding()
virtual bool wxFont::SetFaceName ( const wxString faceName)
virtual

Sets the facename for the font.

Parameters
faceNameA 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 (see wxFontFamily and SetFamily()).
Returns
true if the given face name exists; if the face name doesn't exist in the user's system then the font is invalidated (so that IsOk() will return false) and false is returned.
See also
GetFaceName(), SetFamily()
virtual void wxFont::SetFamily ( wxFontFamily  family)
virtual

Sets the font family.

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

Note that changing the font family results in changing the font face name.

Parameters
familyOne of the wxFontFamily values.
See also
GetFamily(), SetFaceName()
bool wxFont::SetNativeFontInfo ( const wxString info)

Creates the font corresponding to the given native font description string which must have been previously returned by GetNativeFontInfoDesc().

If the string is invalid, font is unchanged. This function is typically used for de-serializing a wxFont object previously saved in a string-form.

Returns
true if the creation was successful.
See also
SetNativeFontInfoUserDesc()
void wxFont::SetNativeFontInfo ( const wxNativeFontInfo info)

Sets the encoding for this font.

Note that under wxGTK this function has no effect (because the underlying Pango library always uses wxFONTENCODING_UTF8).

See also
GetEncoding()
bool wxFont::SetNativeFontInfoUserDesc ( const wxString info)

Creates the font corresponding to the given native font description string and returns true if the creation was successful.

Unlike SetNativeFontInfo(), this function accepts strings which are user-friendly. Examples of accepted string formats are:

platform generic syntax example
wxGTK2 [underlined] [strikethrough] [FACE-NAME] [bold] [oblique|italic] [POINTSIZE] Monospace bold 10
wxMSW [light|bold] [italic] [FACE-NAME] [POINTSIZE] [ENCODING] Tahoma 10 WINDOWS-1252
Todo:
add an example for wxMac

For more detailed information about the allowed syntaxes you can look at the documentation of the native API used for font-rendering (e.g. pango_font_description_from_string under GTK, although notice that it doesn't support the "underlined" and "strikethrough" attributes and so those are handled by wxWidgets itself).

Note that unlike SetNativeFontInfo(), this function doesn't always restore all attributes of the wxFont object under all platforms; e.g. on wxMSW the font family is not restored (because GetNativeFontInfoUserDesc doesn't return it on wxMSW). If you want to serialize/deserialize a font in string form, you should use GetNativeFontInfoDesc() and SetNativeFontInfo() instead.

See also
SetNativeFontInfo()
virtual void wxFont::SetPixelSize ( const wxSize pixelSize)
virtual

Sets the pixel size.

The height parameter of pixelSize must be positive while the width parameter may also be zero (to indicate that you're not interested in the width of the characters: a suitable width will be chosen for best rendering).

This feature (specifying the font pixel size) is directly supported only under wxMSW and wxGTK currently; under other platforms a font with the closest size to the given one is found using binary search (this maybe slower).

See also
GetPixelSize()
virtual void wxFont::SetPointSize ( int  pointSize)
virtual

Sets the point size.

The point size is defined as 1/72 of the Anglo-Saxon inch (25.4 mm): it is approximately 0.0139 inch or 352.8 um.

Parameters
pointSizeSize in points.
See also
GetPointSize()
virtual void wxFont::SetStrikethrough ( bool  strikethrough)
virtual

Sets strike-through attribute of the font.

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

Parameters
strikethroughtrue to add strike-through style, false to remove it.
See also
GetStrikethrough()
Since
2.9.4
virtual void wxFont::SetStyle ( wxFontStyle  style)
virtual

Sets the font style.

Parameters
styleOne of the wxFontStyle enumeration values.
See also
GetStyle()
void wxFont::SetSymbolicSize ( wxFontSymbolicSize  size)

Sets the font size using a predefined symbolic size name.

This function allows to change font size to be (very) large or small compared to the standard font size.

See also
SetSymbolicSizeRelativeTo().
Since
2.9.2
void wxFont::SetSymbolicSizeRelativeTo ( wxFontSymbolicSize  size,
int  base 
)

Sets the font size compared to the base font size.

This is the same as SetSymbolicSize() except that it uses the given font size as the normal font size instead of the standard font size.

Since
2.9.2
virtual void wxFont::SetUnderlined ( bool  underlined)
virtual

Sets underlining.

Parameters
underlinedtrue to underline, false otherwise.
See also
GetUnderlined()
virtual void wxFont::SetWeight ( wxFontWeight  weight)
virtual

Sets the font weight.

Parameters
weightOne of the wxFontWeight values.
See also
GetWeight()
wxFont wxFont::Smaller ( ) const

Returns a smaller version of this font.

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

See also
MakeSmaller(), Larger(), Scaled()
Since
2.9.1
wxFont wxFont::Strikethrough ( ) const

Returns stricken-through version of this font.

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

See also
MakeStrikethrough()
Since
2.9.4
wxFont wxFont::Underlined ( ) const

Returns underlined version of this font.

See also
MakeUnderlined()
Since
2.9.2