Tk_GetJoinStyle(3tk)

📦
version 9.0.4 · 2 versions
, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 Tk_GetJoinStyle(3tk) 💖

okay bestie, pull up a chair 🎀 this one lives in the Tk Library Procedures corner of the manual (section 3tk, iykyk) and it's literally just two little functions that translate between cute human strings and the actual X join styles. no cap.

✨ NAME ✨

Tk_GetJoinStyle, Tk_NameOfJoinStyle — translate between strings and join styles 🦋

✨ SYNOPSIS ✨

#include <tk.h>

int
Tk_GetJoinStyle(interp, string, joinPtr)

const char *
Tk_NameOfJoinStyle(join)

✨ ARGUMENTS ✨

  • Tcl_Interp *interp (in) — the interpreter we use for error reporting, aka where the sad little error message goes if things go sideways 🙈
  • const char *string (in) — a string holding the name of a join style — one of "bevel", "miter", or "round" — or a unique abbreviation of one. yes, abbreviation, she's flexible like that 💅
  • int *joinPtr (out) — pointer to the location where we stash the X join style that matches string
  • int join (in) — a join style, and it's one of JoinBevel, JoinMiter, JoinRound ⭐

✨ DESCRIPTION ✨

so Tk_GetJoinStyle drops the X join style that corresponds to string into *joinPtr, and that style will be one of JoinBevel, JoinMiter, or JoinRound. join styles are typically used in X graphics contexts to say how adjacent line segments should get joined together — like, how do these two lines hug at the corner?? 👑 and fr, go check the X documentation for what each style actually implies, that's not our lore to spill.

under normal circumstances the return value is TCL_OK and interp is just sitting there unused, unbothered, living her life. but if string doesn't contain a valid join style, or an abbreviation of one of these names, then boom: an error message gets stored in interpreter interp's result, TCL_ERROR is returned, and *joinPtr stays unmodified. not touched. not even a little 🫶

Tk_NameOfJoinStyle is the logical inverse of Tk_GetJoinStyle — the mirror, the reverse card, the plot twist 🌈 hand her a join style like JoinBevel and she returns a statically-allocated string corresponding to join. and if join isn't a legal join style? then you get "unknown join style" back. that's it. that's the whole vibe check. 💀

✨ KEYWORDS ✨

bevel, join style, miter, round

and that's the whole page, bestie!! this was the Tk library procedures manual, page Tk_GetJoinStyle(3tk) — source: Tk, version 3tk, no date on this one because apparently we're keeping it mysterious ✨ mwah, slay, go join some line segments 💖🎀🦋

📦 where this page comes from