**********
wx.PaintDC
**********

Inheritance diagram for `wx.PaintDC`:

|

.. inheritance-diagram:: wx.PaintDC

|

Description
===========

A `wx.PaintDC` must be constructed if an application wishes to paint on the client area of a window from within an `OnPaint` event. 
This should normally be constructed as a temporary stack object; don't store a `wx.PaintDC` object. 

Using `wx.PaintDC` within `OnPaint` is important because it automatically sets the clipping area to the damaged area of the window. 
Attempts to draw outside this area do not appear.

To draw on a window from outside `OnPaint`, construct a `wx.ClientDC <wx.ClientDC.html>`_ object.

To draw on the whole window including decorations, construct a `wx.WindowDC <wx.WindowDC.html>`_ object (Windows only).

.. note:: If you have an `OnPaint` handler, you **must** create a `wx.PaintDC` object within it even if you don't actually use it.

.. seealso:: `wx.DC <wx.DC.html>`_, `wx.MemoryDC <wx.MemoryDC.html>`_, `wx.PaintDC <wx.PaintDC.html>`_, `wx.WindowDC <wx.WindowDC.html>`_, 
   `wx.ScreenDC <wx.ScreenDC.html>`_


Derived From
^^^^^^^^^^^^^

* `wx.WindowDC <wx.WindowDC.html>`_ 
* `wx.DC <wx.DC.html>`_ 


Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(win)

   Constructor. Pass the window on which you wish to paint.
   
   **Parameters:**

   * `win` (`wx.Window <wx.Window.html>`_)

   |

   **Returns:**

   `wx.PaintDC <wx.PaintDC.html>`_