Table Of Contents

Previous topic

DCPenChanger

Next topic

DataFormat

This Page

phoenix_title DCTextColourChanger

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


class_hierarchy Inheritance Diagram

Inheritance diagram for class DCTextColourChanger

Inheritance diagram of DCTextColourChanger


method_summary Methods Summary

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

api Class API



class DCTextColourChanger(object)

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

Possible constructors:

DCTextColourChanger(dc)

DCTextColourChanger(dc, col)

Methods



__init__(self, *args, **kw)

overload 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 (DC) –



__init__ (self, dc, col)

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

Parameters:
  • dc (DC) – The DC where the colour must be temporary set.
  • col (Colour) – The colour to set.





Set(self, col)

Set the colour to use.

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

Parameters:col (Colour) –


__enter__(self)


__exit__(self, exc_type, exc_val, exc_tb)