Version: 3.1.3
wxDCTextBgColourChanger Class Reference

#include <wx/dc.h>

Detailed Description

wxDCTextBgColourChanger is a small helper class for setting a background text colour on a wxDC and unsetting it automatically in the destructor, restoring the previous one.

Library:  wxCore
Category:  Graphics Device Interface (GDI)
See also
wxDC::SetTextBackground(), wxDCFontChanger, wxDCPenChanger, wxDCBrushChanger, wxDCClipper, wxDCTextColourChanger, wxDCBgModeChanger
Since
3.1.3

Public Member Functions

 wxDCTextBgColourChanger (wxDC &dc)
 Trivial constructor not changing anything. More...
 
 wxDCTextBgColourChanger (wxDC &dc, const wxColour &col)
 Sets col on the given dc, storing the old one. More...
 
void Set (const wxColour &col)
 Set the background colour to use. More...
 
 ~wxDCTextBgColourChanger ()
 Restores the background colour originally selected in the DC passed to the ctor. More...
 

Constructor & Destructor Documentation

wxDCTextBgColourChanger::wxDCTextBgColourChanger ( wxDC dc)

Trivial constructor not changing anything.

This constructor is useful if you don't know beforehand if the colour 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 colour.

wxDCTextBgColourChanger::wxDCTextBgColourChanger ( wxDC dc,
const wxColour col 
)

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

Parameters
dcThe DC where the colour must be temporary set.
colThe text background colour to set.
wxDCTextBgColourChanger::~wxDCTextBgColourChanger ( )

Restores the background colour originally selected in the DC passed to the ctor.

Member Function Documentation

void wxDCTextBgColourChanger::Set ( const wxColour col)

Set the background colour 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 background colour to the given col and ensures that the old value is restored when this object is destroyed.