wxPaintEvent(3erl)

💖 NAME 💖

wxPaintEvent(3erl) — straight out of the Erlang Module Definition manual — is literally Functions for wxPaintEvent class. Bestie, this is your paint-event bestie page. 🎨✨

---

🌈 DESCRIPTION 🌈

Okay so picture this: a paint event gets sent when a window’s contents need to be repainted. That’s the whole vibe check. 🖌️

The handler of this event must create a wxPaintDC object and use it for painting the window contents. No cap, that’s mandatory. For example:

(the source page says “For example:” right here, but there’s no actual snippet shown — not me staring at an empty example block 😭)

Important bestie warning: you must not create other kinds of wxDC — like wxClientDC or wxWindowDC — in EVT_PAINT handlers. And also don’t create wxPaintDC outside of these event handlers. Periodt. 🚫💅

You can optimize painting by retrieving the rectangles that have been damaged and only repainting those. Iconic efficiency behavior. The rectangles are in terms of the client area, and they’re unscrolled, so you’ll need to do some calculations using the current view position to obtain logical, scrolled units. Math era, unfortunately. 🧮✨

Here is an example of using the wxRegionIterator (not implemented in wx) class:

(again, the source page promises an example right here but shows no code — the snippet is lowkey MIA 🫠)

Remark: please notice that in general it is impossible to change the drawing of a standard control (such as wxButton), so you shouldn’t attempt to handle paint events for them. Even if it might work on some platforms, this is inherently not portable and won’t work everywhere. So like… don’t do it. 🙈

See: Overview events 👀

This class is derived (and can use functions) from: wxEvent. Family tree slay. 🌳💖

wxWidgets docs: wxPaintEvent 📚

---

✨ EVENTS ✨

Use wxEvtHandler:connect/3 with wxPaintEventType to subscribe to events of this type. That’s the subscription link, bestie — click subscribe and get your paint-event notifications. 🔔🎀

---

🎀 DATA TYPES 🎀

wxPaintEvent() = wx:wx_object()

wxPaint() = #wxPaint{type = wxPaintEvent:wxPaintEventType()}

wxPaintEventType() = paint

Literal data-type royalty. paint is the only type in the wxPaintEventType() lineup here, and it ate. 👑💅

---

shoutout to the wxWidgets team — source/version wx 2.2.2.1, manual page wxPaintEvent(3erl) — for this whole paint-event situation. The footer doesn’t give us a date, so no fake-date energy from me, bestie. 🫶💖✨