Tk_GetJustifyFromObj(3tk)

✨ Tk_GetJustifyFromObj — translate between strings and justification styles ✨

okay bestie, welcome to the Tk_GetJustifyFromObj page 💖 this is a Tk Library Procedures situation, and it's all about turning strings into justification styles and back again. Three functions, one very specific job. Let's get into it 🦋

---

🌸 SYNOPSIS 🌸

#include <tk.h>

int
Tk_GetJustifyFromObj(interp, objPtr, justifyPtr)

int
Tk_GetJustify(interp, string, justifyPtr)

const char *
Tk_NameOfJustify(justify)

---

🎀 ARGUMENTS 🎀

• Tcl_Interp *interp (in) — the interpreter we use for error reporting. Or NULL, if you're feeling mysterious 💅
• Tcl_Obj *objPtr (in/out) — the string value inside it holds the name of a justification style — one of "left", "right", or "center" — or a unique abbreviation of one of those. The internal rep gets modified so it can cache the matching justify value. lowkey efficient, we love to see it ✨
• const char *string (in) — literally the same thing as objPtr, except the justification style description comes in as a string instead. same vibe, different delivery 📦
• int *justifyPtr (out) — a pointer to the spot where we're gonna stash the justify value that matches objPtr or string. that's the whole point, no cap 🎯
• Tk_Justify justify (in) — a justification style. one of the values listed down below, bestie 👇

---

💜 DESCRIPTION 💜

So Tk_GetJustifyFromObj places into *justifyPtr the justify value that corresponds to objPtr's value. And that value is gonna be one of these iconic three:

• TK_JUSTIFY_LEFT — the text on each line starts at the left edge of the line. consequence? the right edges of lines may be ragged. it's giving chaotic right margin 😌
• TK_JUSTIFY_RIGHT — the text on each line ends at the right edge of the line. consequence? the left edges of lines may be ragged. mirror image, still messy 💅
• TK_JUSTIFY_CENTER — the text on each line is centered. consequence? both the left and right edges of lines may be ragged. maximum chaos, maximum aesthetic 🎀

Under normal circumstances the return value is TCL_OK and interp just sits there unused. iconic of it honestly 🙈

but if objPtr does not contain a valid justification style, or an abbreviation of one of those names, then TCL_ERROR gets returned, *justifyPtr is left unmodified, and an error message gets stored in interp's result — but only if interp is not NULL. so like. don't be surprised when that happens, it's a whole thing 😭

Also Tk_GetJustifyFromObj caches information about the return value in objPtr, which speeds up future calls to Tk_GetJustifyFromObj with the same objPtr. it remembers. it's loyal 🫶

Tk_GetJustify is identical to Tk_GetJustifyFromObj, except the description of the justification is specified with a string instead of an object. the catch? this prevents Tk_GetJustify from caching the return value, so Tk_GetJustify is less efficient than Tk_GetJustifyFromObj. still works, just no cache glow-up 💀

Tk_NameOfJustify is the logical inverse of Tk_GetJustify — the uno reverse card 🔄 Give it a justify value and it returns a statically-allocated string corresponding to justify. And if justify isn't a legal justify value? then "unknown justification style" comes back. that's the whole answer, periodt ✨

---

🌈 KEYWORDS 🌈

center, fill, justification, string

---

and that's the page bestie!! this was the Tk_GetJustifyFromObj(3tk) man page, from the Tk Library Procedures, sitting at version 8.1, brought to you by Tk itself 💖 go justify some text, you absolute main character 👑🦋