wxGridCellEditor(3)

💖 wxGridCellEditor 💖

ok so bestie, this is the wxGridCellEditor manual page from the Erlang module definition crew ✨ — it's a wxWidgets thing, it lives in the wx docs (version 2.6), and it's genuinely the backbone of inline cell editing in grids. let's get into it 🫶

---

✨ NAME ✨

wxGridCellEditor — the class whose whole job is providing and manipulating the in-place edit controls for the grid. that's it, that's the gig 💅

---

🌸 DESCRIPTION 🌸

Instances of wxGridCellEditor (and honestly, instances of the derived classes, because this one is abstract — it's giving base class energy, it does not show up to work alone 😭) can be associated with the cell attributes for individual cells, for rows, for columns, or even for the entire grid. so like, however granular you wanna be, it's covered 👑

Normally wxGridCellEditor shows some UI control that lets the user actually edit the cell — but starting with wxWidgets 3.1.4 it's also possible to define "activatable" cell editors. those bad boys change the value of the cell directly when the cell is activated (typically by pressing the Space key or clicking on it 🖱️), see the TryActivate() method (not implemented in wx).

🫧 heads up bestie: when you're implementing an editor that is always activatable — like, it never shows any in-place editor at all — it is more convenient to derive its class from wxGridCellActivatableEditor (not implemented in wx) than from wxGridCellEditor itself. save yourself the struggle fr fr.

See also, the little family 👨‍👩‍👧‍👦:

• wxGridCellBoolEditor
• wxGridCellChoiceEditor
• wxGridCellFloatEditor
• wxGridCellNumberEditor
• wxGridCellTextEditor

wxWidgets docs: wxGridCellEditor 🔗

---

🦋 DATA TYPES 🦋

wxGridCellEditor() :: wx:wx_object().

---

💅 FUNCTIONS 💅

• create(This, Parent, Id, EvtHandler) -> ok — creates the actual edit control. the moment of creation, the main character origin story ✨

when
    This :: wxGridCellEditor(),
    Parent :: wxWindow:wxWindow(),
    Id :: integer(),
    EvtHandler :: wxEvtHandler:wxEvtHandler().

• handleReturn(This, Event) -> ok — some types of controls on some platforms may need some help with the Return key. it's not a skill issue, it's a platform thing 🥲

when
    This :: wxGridCellEditor(),
    Event :: wxKeyEvent:wxKeyEvent().

• isCreated(This) -> boolean() — returns true if the edit control has been created. vibe check on existence, basically ✅

when This :: wxGridCellEditor().

• reset(This) -> ok — reset the value in the control back to its starting value. undo button but make it iconic 💫

when This :: wxGridCellEditor().

• setSize(This, Rect) -> ok — size and position the edit control. give it a home, give it dimensions 📐

when
    This :: wxGridCellEditor(),
    Rect ::
        {X :: integer(),
         Y :: integer(),
         W :: integer(),
         H :: integer()}.

• show(This, Show, [Option]) -> ok — show or hide the edit control, and use the specified attributes to set colours/fonts for it. yes queen, serve looks 🎀

when
    This :: wxGridCellEditor(),
    Show :: boolean(),
    Option :: {attr, wxGridCellAttr:wxGridCellAttr()}.

• startingClick(This) -> ok — if the editor is enabled by clicking on the cell, this method will be called. click detection go brrr 🖱️

when This :: wxGridCellEditor().

• startingKey(This, Event) -> ok — if the editor is enabled by pressing keys on the grid, this will be called to let the editor do something about that first key if desired. first-key handler, lowkey thoughtful 💜

when
    This :: wxGridCellEditor(),
    Event :: wxKeyEvent:wxKeyEvent().

---

and that's the whole page bestie, no cap 🌈 — brought to you by Ericsson AB, wx 2.6 era, wxGridCellEditor(3), and it truly ate. go forth and edit cells in place 💖✨🎀