.. include:: headings.inc



.. _DCTextColourChanger:

==========================================================================================================================================
|phoenix_title|  **DCTextColourChanger**
==========================================================================================================================================

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







         



.. seealso:: :meth:`DC.SetTextForeground` , :ref:`DCFontChanger`, :ref:`DCPenChanger`, :ref:`DCBrushChanger`, :ref:`DCClipper`    







|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **DCTextColourChanger**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/DCTextColourChanger_inheritance.png" alt="Inheritance diagram of DCTextColourChanger" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="DCTextColourChanger.html" title="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." alt="" coords="5,5,192,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~DCTextColourChanger.__init__`                                            Trivial constructor not changing anything.
:meth:`~DCTextColourChanger.Set`                                                 Set the colour to use.
:meth:`~DCTextColourChanger.__enter__`                                           
:meth:`~DCTextColourChanger.__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)
       



   .. method:: __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 :meth:`Set`   is called -- in which case it would reset the previous colour.                  
      
      
      :param `dc`: 
      :type `dc`: DC
      
      
      
      
      
      
      **~~~**

      
      **__init__** `(self, dc, col)`
      
      Sets `col`  on the given `dc`, storing the old one.                  
      
      
      
      
      :param `dc`: The DC where the colour must be temporary set.   
      :type `dc`: DC
      :param `col`: The colour to set.   
      :type `col`: Colour
      
      
      
      
      
      
                        
      
      
      
      
      **~~~**






   .. method:: 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 :ref:`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.                  


      :param `col`: 
      :type `col`: Colour







   .. method:: __enter__(self)




   .. method:: __exit__(self, exc_type, exc_val, exc_tb)