Version: 3.1.0
wxDCFontChanger Class Reference

#include <wx/dc.h>

Detailed Description

wxDCFontChanger is a small helper class for setting a font on a wxDC and unsetting it automatically in the destructor, restoring the previous one.

Since
2.9.0

Library:  wxCore
Category:  Graphics Device Interface (GDI)
See Also
wxDC::SetFont(), wxDCTextColourChanger, wxDCPenChanger, wxDCBrushChanger, wxDCClipper

Public Member Functions

 wxDCFontChanger (wxDC &dc)
 Trivial constructor not changing anything.
 
 wxDCFontChanger (wxDC &dc, const wxFont &font)
 Sets font on the given dc, storing the old one.
 
void Set (const wxFont &font)
 Set the font to use.
 
 ~wxDCFontChanger ()
 Restores the font originally selected in the DC passed to the ctor.
 

Constructor & Destructor Documentation

wxDCFontChanger::wxDCFontChanger ( wxDC dc)

Trivial constructor not changing anything.

This constructor is useful if you don't know beforehand if the font needs to be changed or not. It simply creates the object which won't do anything in its destructor unless Set() is called – in which case it would reset the previous font.

Since
2.9.1
wxDCFontChanger::wxDCFontChanger ( wxDC dc,
const wxFont font 
)

Sets font on the given dc, storing the old one.

Parameters
dcThe DC where the font must be temporary set.
fontThe font to set.
wxDCFontChanger::~wxDCFontChanger ( )

Restores the font originally selected in the DC passed to the ctor.

Member Function Documentation

void wxDCFontChanger::Set ( const wxFont font)

Set the font to use.

This method is meant to be called once only and only on the objects created with the constructor overload not taking wxColour argument and has the same effect as the other constructor, i.e. sets the font to the given font and ensures that the old value is restored when this object is destroyed.