.. include:: headings.inc



.. _DCOverlay:

==========================================================================================================================================
|phoenix_title|  **DCOverlay**
==========================================================================================================================================

Connects an overlay with a drawing DC.          





         



.. seealso:: :ref:`Overlay`, :ref:`DC`    







|

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

Inheritance diagram for class **DCOverlay**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/DCOverlay_inheritance.png" alt="Inheritance diagram of DCOverlay" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="DCOverlay.html" title="Connects an overlay with a drawing DC." alt="" coords="5,5,88,35"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~DCOverlay.__init__`                                                      Connects this overlay to the corresponding drawing dc, if the overlay is not initialized yet this call will do so.
:meth:`~DCOverlay.Clear`                                                         Clears the layer, restoring the state at the last init.
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: DCOverlay(object)

   Connects an overlay with a drawing DC.
   
   **Possible constructors**::

       DCOverlay(overlay, dc, x, y, width, height)
       
       DCOverlay(overlay, dc)
       



   .. method:: __init__(self, *args, **kw)



      |overload| **Overloaded Implementations**:

      **~~~**

      
      **__init__** `(self, overlay, dc, x, y, width, height)`
      
      Connects this overlay to the corresponding drawing dc, if the overlay is not initialized yet this call will do so.                  
      
      
      :param `overlay`: 
      :type `overlay`: Overlay
      :param `dc`: 
      :type `dc`: DC
      :param `x`: 
      :type `x`: int
      :param `y`: 
      :type `y`: int
      :param `width`: 
      :type `width`: int
      :param `height`: 
      :type `height`: int
      
      
      
      
      
      
      **~~~**

      
      **__init__** `(self, overlay, dc)`
      
      Convenience wrapper that behaves the same using the entire area of the dc.                  
      
      
      :param `overlay`: 
      :type `overlay`: Overlay
      :param `dc`: 
      :type `dc`: DC
      
      
      
      
      
      
      **~~~**






   .. method:: Clear(self)

      Clears the layer, restoring the state at the last init.