wx.DCTextBgColourChanger

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

New in version 4.1/wxWidgets-3.1.3.

See also

wx.DC.SetTextBackground , wx.DCFontChanger, wx.DCPenChanger, wx.DCBrushChanger, wx.DCClipper, wx.DCTextColourChanger, DCBgModeChanger

Class Hierarchy

Inheritance diagram for class DCTextBgColourChanger:

Methods Summary

__init__	Trivial constructor not changing anything.
Set	Set the background colour to use.
__enter__
__exit__

Class API

class wx.DCTextBgColourChanger(object)

Possible constructors:

DCTextBgColourChanger(dc)

DCTextBgColourChanger(dc, col)

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

Methods

__init__(self, *args, **kw)

Overloaded Implementations:

---

__init__ (self, 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.

Parameters:

dc (wx.DC) –

---

__init__ (self, dc, col)

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

Parameters:

• dc (wx.DC) – The DC where the colour must be temporary set.

• col (wx.Colour) – The text background colour to set.

---

---

Set(self, 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 wx.Colour 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.

Parameters:

col (wx.Colour) –

---

__enter__(self)

---

__exit__(self, exc_type, exc_val, exc_tb)