File: wx.PaintDC.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (113 lines) | stat: -rw-r--r-- 3,947 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
.. 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.PaintDC:

==========================================================================================================================================
|phoenix_title|  **wx.PaintDC**
==========================================================================================================================================

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

This should normally be constructed as a temporary stack object; don't store a :ref:`wx.PaintDC`  object. If you have an EVT_PAINT() handler, you `must`  create a :ref:`wx.PaintDC`  object within it even if you don't actually use it. 

Using :ref:`wx.PaintDC`  within your EVT_PAINT() handler 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 your EVT_PAINT() handler, construct a :ref:`wx.ClientDC`  object. 

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

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







         



.. seealso:: :ref:`wx.DC`, :ref:`wx.ClientDC`, :ref:`wx.MemoryDC`, :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>PaintDC</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.PaintDC_inheritance.png" alt="Inheritance diagram of PaintDC" 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="wx.WindowDC" alt="" coords="5,160,112,189"/> <area shape="rect" id="node4" href="wx.ClientDC.html" title="wx.ClientDC" alt="" coords="10,237,107,267"/> <area shape="rect" id="node2" href="wx.DC.html" title="wx.DC" alt="" coords="23,83,95,112"/> <area shape="rect" id="node3" href="wx.PaintDC.html" title="wx.PaintDC" alt="" coords="13,315,104,344"/> <area shape="rect" id="node5" href="wx.Object.html" title="wx.Object" alt="" coords="17,5,99,35"/> </map> 
   </p>

|


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

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


|


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


.. class:: wx.PaintDC(ClientDC)

   **Possible constructors**::

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



   .. method:: __init__(self, window)

      Constructor.                  

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


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