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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
.. 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.EraseEvent:
==========================================================================================================================================
|phoenix_title| **wx.EraseEvent**
==========================================================================================================================================
An erase event is sent when a window's background needs to be repainted.
On some platforms, such as GTK+, this event is simulated (simply generated just before the paint event) and may cause flicker. It is therefore recommended that you set the text background colour explicitly in order to prevent flicker. The default background colour under GTK+ is grey.
To intercept this event, use the ``EVT_ERASE_BACKGROUND`` macro in an event table definition.
You must use the device context returned by :meth:`~wx.EraseEvent.GetDC` to draw on, don't create a :ref:`wx.PaintDC` in the event handler.
.. _EraseEvent-events:
|events| Events Emitted by this Class
=====================================
Handlers bound for the following event types will receive a :ref:`wx.EraseEvent` parameter.
Event macros:
- EVT_ERASE_BACKGROUND: Process a ``wxEVT_ERASE_BACKGROUND`` event.
.. seealso:: :ref:`Events and Event Handling <events and event handling>`
|
|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>EraseEvent</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.EraseEvent_inheritance.png" alt="Inheritance diagram of EraseEvent" 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.Event.html" title="wx.Event" alt="" coords="23,83,101,112"/> <area shape="rect" id="node3" href="wx.EraseEvent.html" title="wx.EraseEvent" alt="" coords="5,160,120,189"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="21,5,103,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.EraseEvent.__init__` Constructor.
:meth:`~wx.EraseEvent.GetDC` Returns the device context associated with the erase event to draw on.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.EraseEvent.DC` See :meth:`~wx.EraseEvent.GetDC`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.EraseEvent(Event)
**Possible constructors**::
EraseEvent(id=0, dc=None)
An erase event is sent when a window's background needs to be
repainted.
.. method:: __init__(self, id=0, dc=None)
Constructor.
:param `id`:
:type `id`: int
:param `dc`:
:type `dc`: wx.DC
.. method:: GetDC(self)
Returns the device context associated with the erase event to draw on.
The returned pointer is never ``None``.
:rtype: :ref:`wx.DC`
.. attribute:: DC
See :meth:`~wx.EraseEvent.GetDC`
|
