wxGridCellRenderer(3)

💅 wxGridCellRenderer — bestie edition 💅

okay so this is the wxGridCellRenderer page from the Erlang module definitions, and it's literally the glow-up artist for your grid cells. no cap.

---

✨ NAME ✨

wxGridCellRenderer — this class is the one actually responsible for drawing the cell in the grid. it's giving artiste. it's giving main character. 🎀

---

🦋 DESCRIPTION 🦋

so here's the vibe: you hand this thing over to wxGridCellAttr (the one listed below, iykyk) when you want to change the format of one specific cell, or you pass it to wxGrid:setDefaultRenderer/2 when you want to change the look of all the cells. either way, it's doing the most. 💖

IMPORTANT: this is an abstract class. lowkey you can't just use it raw like that. you will normally use one of the predefined derived classes (list below ⬇️) or derive your own class from it. periodt.

See also, bestie: 🌈

• wxGridCellBoolRenderer
• wxGridCellFloatRenderer
• wxGridCellNumberRenderer
• wxGridCellStringRenderer

also, wxWidgets docs: wxGridCellRenderer — if you want the original source material, it's right there. 📚

---

🌸 DATA TYPES 🌸

wxGridCellRenderer() :: wx:wx_object().

that's it. that's the type. she's a wx:wx_object(). iconic. ✨

---

👑 FUNCTIONS 👑

🌟 draw(This, Grid, Attr, Dc, Rect, Row, Col, IsSelected) -> ok

sooo the full signature is:

draw(This, Grid, Attr, Dc, Rect, Row, Col, IsSelected) -> ok
              when
                  This :: wxGridCellRenderer(),
                  Grid :: wxGrid:wxGrid(),
                  Attr :: wxGridCellAttr:wxGridCellAttr(),
                  Dc :: wxDC:wxDC(),
                  Rect ::
                      {X :: integer(),
                       Y :: integer(),
                       W :: integer(),
                       H :: integer()},
                  Row :: integer(),
                  Col :: integer(),
                  IsSelected :: boolean().

what does it do? it draws the given cell on the provided DC, inside the given rectangle, using the style specified by the attribute, plus the default-or-selected state that corresponds to the isSelected value. slay. 💅

now listen — this is a pure virtual function, but it does have a default implementation. and that default implementation is not lazy, bestie, it will prepare the DC using the given attribute: it draws the rectangle with the background colour from attr and sets the text colour and font. she did that. 🫶

---

🌟 getBestSize(This, Grid, Attr, Dc, Row, Col) -> {W :: integer(), H :: integer()}

full signature:

getBestSize(This, Grid, Attr, Dc, Row, Col) ->
                    {W :: integer(), H :: integer()}
                    when
                        This :: wxGridCellRenderer(),
                        Grid :: wxGrid:wxGrid(),
                        Attr :: wxGridCellAttr:wxGridCellAttr(),
                        Dc :: wxDC:wxDC(),
                        Row :: integer(),
                        Col :: integer().

get the preferred size of the cell for its contents. basically: how much room does this content need to breathe? 🧚

heads up, bestie: this method must be overridden in the derived classes to return the minimal fitting size for displaying the content of the given grid cell. no override, no size. don't skip it. 🙈

---

and that's the whole page, bestie 💜

this was brought to you by Ericsson AB, from wx 2.6, and yes the page itself is wxGridCellRenderer(3). go forth and render some cells. you're gonna eat. 🔥🌈⭐