Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

wxEraseEvent (3erl)

Name

wxEraseEvent - Functions for wxEraseEvent class

Synopsis

Please see following description for synopsis

Description

wxEraseEvent(3)            Erlang Module Definition            wxEraseEvent(3)



NAME
       wxEraseEvent - Functions for wxEraseEvent class

DESCRIPTION
       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 gener-
       ated  just  before the paint event) and may cause flicker. It is there-
       fore 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 getDC/1 to draw on, don't
       create a wxPaintDC in the event handler.

       See: Overview events

       This class is derived (and can use functions) from: wxEvent

       wxWidgets docs: wxEraseEvent

EVENTS
       Use wxEvtHandler:connect/3 with wxEraseEventType to subscribe to events
       of this type.

DATA TYPES
       wxEraseEvent() = wx:wx_object()

       wxErase() =
           #wxErase{type = wxEraseEvent:wxEraseEventType(),
                    dc = wxDC:wxDC()}

       wxEraseEventType() = erase_background

EXPORTS
       getDC(This) -> wxDC:wxDC()

              Types:

                 This = wxEraseEvent()

              Returns  the  device  context associated with the erase event to
              draw on.

              The returned pointer is never NULL.



wxWidgets team.                    wx 2.1.1                    wxEraseEvent(3)