struct(3U)

💖 struct(3U) 💖

okay bestie, welcome to the InterViews Reference Manual ✨ this one lives in section 3U and it's literally all about the little command girlies that restructure your components. no cap.

🌸 NAME 🌸

BackCmd</purl>, FrontCmd, GroupCmd, UngroupCmd — commands for modifying components structurally 🎀

✨ SYNOPSIS ✨

#include <Unidraw/Commands/struct.h>

🦋 DESCRIPTION 🦋

So. BackCmd, FrontCmd, GroupCmd, and UngroupCmd are purely interpretive commands — they're not out here doing the work themselves, they're the main character energy that lets the structure of their editor's component get altered. 💅

The way that all four of them redefine their Execute and Unexecute operations? iconic. It's so the editor's component can interpret them however it wants. fr fr, they just hand over the vibe and let the component do its thing. 🫶

👑 BACKCMD PUBLIC OPERATIONS 👑

• BackCmd(ControlInfo*)
• BackCmd(Editor* = nil)

Construct a new BackCmd. that's it, that's the whole thing, slay. ✨

🌈 FRONTCMD PUBLIC OPERATIONS 🌈

• FrontCmd(ControlInfo*)
• FrontCmd(Editor* = nil)

Construct a new FrontCmd. periodt. 💖

🎀 GROUPCMD PUBLIC OPERATIONS 🎀

• GroupCmd(ControlInfo*, GraphicComp* = nil)
• GroupCmd(Editor* = nil, GraphicComp* = nil)

Create a new GroupCmd, and if you want, you can optionally specify the component into which components will be grouped. 🧚

• virtual void Execute()
• virtual void Unexecute()

Okay so Execute will set the value of the _executed protected member variable to true as a side effect — but only if anything was actually grouped. No grouping, no true, bestie. 🙈

Similarly, Unexecute will reset the value to false as a side effect, once the operation was undone. 💫

• GraphicComp* GetGroup()
• void SetGroup(GraphicComp*)

Get or set the component into which components will be grouped. 👑

⚠️ heads up: SetGroup will not delete the old value. it just ghosts it. 💀

💜 UNGROUPCMD PUBLIC OPERATIONS 💜

• UngroupCmd(ControlInfo*)
• UngroupCmd(Editor* = nil)

Construct a new UngroupCmd. she's new here, be nice. 🎀

• virtual void Execute()
• virtual void Unexecute()

Execute will set the value of the _executed protected member variable to true as a side effect if anything was ungrouped. 💥

Similarly, Unexecute will reset the value to false as a side effect once the operation was undone. 🌸

• Clipboard* GetKids()
• void SetKids(Clipboard*)

Explicitly set and get a clipboard containing the child components that were ungrouped. Where does it live? In the _kids protected member. 🍼

Now here's the tea: UngroupCmd does not initialize this member. It merely provides the storage as a convenience to components that interpret the command and need a place to store the ungrouped children — because they need somewhere to keep them to support reverse execution. lowkey a little lending library. 📚

However (and this part matters), UngroupCmd deletes the clipboard (if it exists) in ~UngroupCmd. so if you put something there, the destructor is gonna take it out. 😭

⚠️ also: SetKids will not delete the old value. same energy as SetGroup. no cleanup, no cap. 💀

🔥 SEE ALSO 🔥

• Command(3U)
• GraphicComp(3U)

and that's the whole page bestie!! 🦋 this one came to you from Unidraw, dated 24 January 1991 — yes she's vintage, yes she still ate, we love a classic. 💖✨👑