.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2018 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc



.. _wx.ClientDC:

==========================================================================================================================================
|phoenix_title|  **wx.ClientDC**
==========================================================================================================================================

A :ref:`wx.ClientDC`  must be constructed if an application wishes to paint on the client area of a window from outside an EVT_PAINT() handler.          

This should normally be constructed as a temporary stack object; don't store a :ref:`wx.ClientDC`  object. 

To draw on a window from within an EVT_PAINT() handler, construct a :ref:`wx.PaintDC`  object instead. 

To draw on the whole window including decorations, construct a :ref:`wx.WindowDC`  object (Windows only). 

A :ref:`wx.ClientDC`  object is initialized to use the same font and colours as the window it is associated with. 







         



.. seealso:: :ref:`wx.DC`, :ref:`wx.MemoryDC`, :ref:`wx.PaintDC`, :ref:`wx.WindowDC`, :ref:`wx.ScreenDC`    







|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>ClientDC</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.ClientDC_inheritance.png" alt="Inheritance diagram of ClientDC" usemap="#dummy" class="inheritance"/></center>
   </div>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.WindowDC.html" title="A wx.WindowDC  must be constructed if an application wishes to paint on the whole area of a window (client and decorations)." alt="" coords="5,160,113,189"/> <area shape="rect" id="node4" href="wx.ClientDC.html" title="A wx.ClientDC  must be constructed if an application wishes to paint on the client area of a window from outside an EVT_PAINT() handler." alt="" coords="11,237,108,267"/> <area shape="rect" id="node2" href="wx.DC.html" title="A wx.DC  is a `'device context'`  onto which graphics and text can be drawn." alt="" coords="23,83,95,112"/> <area shape="rect" id="node3" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="18,5,101,35"/> </map> 
   </p>

|


|sub_classes| Known Subclasses
==============================

:ref:`wx.PaintDC`

|


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

================================================================================ ================================================================================
:meth:`~wx.ClientDC.__init__`                                                    Constructor.
================================================================================ ================================================================================


|


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


.. class:: wx.ClientDC(WindowDC)

   **Possible constructors**::

       ClientDC(window)
       
   
   A ClientDC must be constructed if an application wishes to paint on
   the client area of a window from outside an EVT_PAINT() handler.



   .. method:: __init__(self, window)

      Constructor.                  

      Pass a pointer to the window on which you wish to paint.                  


      :param `window`: 
      :type `window`: wx.Window