wxEraseEvent(3erl)

🦋 NAME 🦋

okay so bestie, welcome to the wxEraseEvent(3erl) page — it's the Erlang module definition for wxEraseEvent, and it's literally the functions for the wxEraseEvent class. 💅✨

🌸 DESCRIPTION 🌸

An erase event is sent when a window's background needs to be repainted. periodt.

On some platforms, such as GTK+, this event is simulated — simply generated just before the paint event — and it 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 getDC/1 to draw on, and do not create a wxPaintDC in the event handler. Like, don't even think about it. 💀

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. That's the whole move. 🎟️

🎀 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. no cap.

---

okay that's the page, bestie! 💖 big love to the wxWidgets team, version wx 2.2.2.1, and this is the wxEraseEvent(3erl) manual. The footer didn't list a date, so I'm not inventing one — mwah! 🫶🎀✨