.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.Overlay:
==========================================================================================================================================
|phoenix_title| **wx.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:`wx.MemoryDC`.
.. seealso:: :ref:`wx.DCOverlay`, :ref:`wx.DC`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
Overlay:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.Overlay.__init__`
:meth:`~wx.Overlay.Reset` Clears the overlay without restoring the former state.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.Overlay(object)
**Possible constructors**::
Overlay() -> None
Creates an overlay over an existing window, allowing for manipulations
like rubberbanding, etc.
.. method:: __init__(self)
:rtype: `None`
.. 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.
:rtype: `None`