EditorInfo(3U)

🎀 NAME 🎀

EditorInfo — the lil container that stores information about an editor's contents. that's it, that's the whole job, and honestly? it does it flawlessly. 💅

oh also hi bestie, this is the EditorInfo(3U) page from the InterViews Reference Manual and I'm gonna walk you through every single bit of it, no skips, no shortcuts. 🫶

✨ SYNOPSIS ✨

#include <Unidraw/editorinfo.h>

one include. that's the entire entrance. we love a low-effort icon. 👑

🦋 DESCRIPTION 🦋

An EditorInfo object is a UMap that stores a list of strings and/or string tuples. periodt.

Application-specific editors can use these objects to store information about what components, commands, and tools they incorporate in their interface. The programmer can write out this information with a catalog object and read it back in later. The application can then let the user change the editor's configuration by editing the catalog-generated file. it's giving "your tool palette but it's a save file" and I'm obsessed. 🔥

fr fr example, straight from the source: an EditorInfo object could have a list of names for tools in the editor's interface that have been saved with the catalog. When the application is restarted, the EditorInfo object can be read first, and then the catalog can reconstruct the tools given their names. like?? that's so clean?? 🧚

💅 PUBLIC OPERATIONS 💅

• EditorInfo() — Construct an EditorInfo instance. bam. born. a fresh lil baby map. 🎀
• void Register(const char* name, const char* info = "")
• void UnregisterName(const char*)
• void UnregisterInfo(const char*)
• boolean Registered(const char* name)

okay so these four are a squad and they share a description, so buckle up: Register enters a name or name-info tuple into the EditorInfo object. UnregisterName removes an entry whose name string matches the given one, while UnregisterInfo removes an entry whose info string matches the given one. And the Registered operation returns whether or not an entry with a matching name exists. yes bestie, Registered is literally a vibe check for your entries. ⭐

• const char* GetName(const char* info)
• const char* GetInfo(const char* name)

these two are the name-info tuple lookup operations. The GetName operation returns the name corresponding to a given info string, while the GetInfo operation returns the info string for a given name. it's giving mutuals. they know each other. 🦋

• const char* GetName(int index)
• const char* GetInfo(int index)

Name or info strings can be accessed by an index that reflects the order in which they were registered. These operations return the name or info string for a given index. so if you registered it third, it's index three energy. number-coded and unbothered. 🔢✨

🌈 SEE ALSO 🌈

• Catalog(3U)
• Editor(3U)
• UMap(3U)

and that's the whole page bestie!! 🫶 this one is Unidraw, dated 30 July 1990 — yes, the date is older than us, and it's still serving. go forth and store your editor info, you absolute main character. 💖✨🎀