File: wx.ClientDC.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 (119 lines) | stat: -rw-r--r-- 3,599 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
114
115
116
117
118
119
.. 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="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.Object.html" title="wx.Object" alt="" coords="17,5,99,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