.. include:: headings.inc



.. _Overlay:

==========================================================================================================================================
|phoenix_title|  **Overlay**
==========================================================================================================================================

Creates an overlay over an existing window, allowing for manipulations like rubberbanding, etc.          

On wxOSX the overlay is implemented with native platform APIs, on the other platforms it is simulated using :ref:`MemoryDC`. 





         



.. seealso:: :ref:`DCOverlay`, :ref:`DC`    







|

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

Inheritance diagram for class **Overlay**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/Overlay_inheritance.png" alt="Inheritance diagram of Overlay" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Overlay.html" title="Creates an overlay over an existing window, allowing for manipulations like rubberbanding, etc." alt="" coords="5,5,77,35"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~Overlay.__init__`                                                        
:meth:`~Overlay.Reset`                                                           Clears the overlay without restoring the former state.
================================================================================ ================================================================================


|


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

.. class:: Overlay(object)

   Creates an overlay over an existing window, allowing for manipulations like rubberbanding, etc.
   
   **Possible constructors**::

       Overlay()
       



   .. method:: __init__(self)






   .. method:: Reset(self)

      Clears the overlay without restoring the former state.                  

      To be done, for example, when the window content has been changed and repainted.