<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">

<!-- THIS FILE IS GENERATED DO NOT EDIT -->


<erlref>
<header>
  <copyright>
    <year>2020</year>
    <holder>Ericsson AB. All Rights Reserved.</holder></copyright>
  <legalnotice>
      Licensed under the Apache License, Version 2.0 (the "License");
      you may not use this file except in compliance with the License.
      You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      See the License for the specific language governing permissions and
      limitations under the License.

  </legalnotice>
  <title>wxEraseEvent</title>
</header>
<module>wxEraseEvent</module>
<modulesummary>Functions for wxEraseEvent class</modulesummary>
<description><p>An erase event is sent when a window's background needs to be repainted.
      </p><p>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.
      </p><p>To intercept this event, use the EVT_ERASE_BACKGROUND macro in an event table definition.
      </p><p>You must use the device context returned by <seemfa marker="#getDC/1"><c>getDC/1</c></seemfa> to draw on, don't create a <seeerl marker="wxPaintDC"><c>wxPaintDC</c></seeerl> in the event handler.
      </p><p>See: <url href="https://docs.wxwidgets.org/3.1/overview_events.html#overview_events">Overview events</url>
      </p>
  <p>This class is derived (and can use functions) from: 
    <seeerl marker="wxEvent"><c>wxEvent</c></seeerl></p>
  
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_erase_event.html">wxEraseEvent</url></p>
  </description><section><title>Events</title><p>Use <seemfa marker="wxEvtHandler#connect/3"><c>wxEvtHandler:connect/3</c></seemfa> with <seetype marker="#wxEraseEventType"><c>wxEraseEventType</c></seetype> to subscribe to events of this type.</p></section>
<datatypes>
    <datatype><name name="wxEraseEvent"/></datatype>
    <datatype><name name="wxErase"/></datatype>
    <datatype><name name="wxEraseEventType"/></datatype></datatypes>

<funcs>
  <func>
    <name name="getDC" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the device context associated with the erase event to draw on. </fsummary>
    <desc><p>Returns the device context associated with the erase event to draw on. 
      </p><p>The returned pointer is never NULL. 
      </p></desc>
  </func>
  </funcs>
</erlref>
