File: wx.PaintDC.txt

package info (click to toggle)
wxpython4.0 4.2.0%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 232,540 kB
  • sloc: cpp: 958,937; python: 233,059; ansic: 150,441; makefile: 51,662; sh: 8,687; perl: 1,563; javascript: 584; php: 326; xml: 200
file content (107 lines) | stat: -rw-r--r-- 3,737 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
.. 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.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. 

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>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.PaintDC.html" title="wx.PaintDC" alt="" coords="15,315,111,344"/> <area shape="rect" id="node2" href="wx.ClientDC.html" title="wx.ClientDC" alt="" coords="12,237,115,267"/> <area shape="rect" id="node3" href="wx.WindowDC.html" title="wx.WindowDC" alt="" coords="5,160,121,189"/> <area shape="rect" id="node4" href="wx.DC.html" title="wx.DC" alt="" coords="27,83,99,112"/> <area shape="rect" id="node5" href="wx.Object.html" title="wx.Object" alt="" coords="20,5,107,35"/> </map> 
   </p>
   </div>

|


|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