iwidgets::labeledwidget(1)

💖 iwidgets::labeledwidget — the manual, but make it cute 💖

okay bestie, welcome to the iwidgets::labeledwidget(1) page, filed under [incr Widgets], section 1, Tk family. it's giving base class energy and honestly? iconic. let's go 🦋

---

✨ NAME ✨

iwidgets::labeledwidget — create and manipulate a labeled widget. yeah. that's the whole job. she labels. she widgets. 💅

---

✨ SYNOPSIS ✨

iwidgets::labeledwidget pathName ?options?

---

✨ INHERITANCE ✨

follow the family tree, bestie:

itk::Widget <- iwidgets::Labeledwidget

so itk::Widget is the parent, and iwidgets::Labeledwidget is the iconic offspring. 🌸

---

✨ STANDARD OPTIONS ✨

these three come free with the widget, no notes:

• background
• cursor
• foreground

head over to the "options" manual entry if you want the full tea on what the standard options do. ☕

---

✨ WIDGET-SPECIFIC OPTIONS ✨

this is the main character section fr fr. every one of these gets a Name, a Class, and a Command-Line Switch:

• Name: disabledForeground · Class: DisabledForeground · Command-Line Switch: -disabledforeground — sets the foreground color that shows up when the state is disabled. glow-down mode. 🥀
• Name: labelBitmap · Class: Bitmap · Command-Line Switch: -labelbitmap — the bitmap to display in the widget, in any of the forms that Tk_GetBitmap accepts. heads up: this one overrides the labeltext option. bitmap wins, no debate. 🔥
• Name: labelFont · Class: Font · Command-Line Switch: -labelfont — the font used for the label. dress her up. 🎀
• Name: labelImage · Class: Image · Command-Line Switch: -labelimage — an image to use as the label. can be any of the values made by the image create command. and listen: this option overrides both the labelbitmap and labeletext options. (yes, that's spelled labeletext in the original, we don't fix, we preserve. 😭)
• Name: labelMargin · Class: Margin · Command-Line Switch: -labelmargin — the distance between the childsite and the label, in any of the forms Tk_GetPixels accepts. default is 2 pixel. personal space matters. ✨
• Name: labelPos · Class: Position · Command-Line Switch: -labelpos — where the label sits along the side of the childsite: nw, n, ne, sw, s, se, en, e, es, wn, w, or ws. default is w. pick your placement, queen. 👑
• Name: labelText · Class: Text · Command-Line Switch: -labeltext — the text of the label around the childsite.
• Name: labelVariable · Class: Variable · Command-Line Switch: -labelvariable — the text variable of the label around the childsite. live-updating label, slay. 🌈
• Name: state · Class: State · Command-Line Switch: -state — one of two states for the label: normal or disabled. if the label is disabled it's displayed in a disabled foreground color. default is normal.
• Name: sticky · Class: Sticky · Command-Line Switch: -sticky — the "sticky-ness" of the childsite. default value is nsew, which is the the same behavior of the labeledwidget before this option was added. (the the. we keep the the. 💀)

---

✨ DESCRIPTION ✨

the iwidgets::labeledwidget command creates a labeled widget that contains a label and a child site. the child site is a frame, and you can fill it with literally any widget — either through a derived class, or by using the childsite method. this class was designed to be a general purpose base class for supporting the combo of a label widget and a childsite. the options include the ability to position the label around the childsite widget, modify the font and margin, and control the display of the labels. versatile icon. 💖

---

✨ METHODS ✨

the iwidgets::labeledwidget command creates a new Tcl command whose name is pathName. you use this command to invoke various operations on the widget. general form, bestie:

pathName option ?arg arg ...?

option and the args decide exactly what the command does. here are the commands available for labeledwidget widgets: 🫶

---

✨ WIDGET-SPECIFIC METHODS ✨

• pathName childsite — return the path name of the child site. that's it. that's the method. ✨
• pathName cget option — returns the current value of the configuration option given by option. option may have any of the values accepted by the iwidgets::labeledwidget command.
• pathName configure ?option? ?value option value ...? — query or modify the configuration options of the widget. if no option is specified, it returns a list describing all of the available options for pathName (see Tk_ConfigureInfo for info on the format of this list). if option is specified with no value, the command returns a list describing that one named option (this list will be identical to the corresponding sublist of the value returned when no option is specified). if one or more option-value pairs are specified, the command modifies the given widget option(s) to have the given value(s) — and in that case the command returns an empty string. option may have any of the values accepted by the iwidgets::labeledwidget command.

---

✨ STATIC METHODS ✨

• iwidgets::Labeledwidget::alignlabels widget ?widget ...? — the alignlabels procedure takes a list of widgets derived from the Labeledwidget class and uses the label margin to make each widget have the same total space for the combination of label and margin. the net effect is that the labels get left aligned. ngl, this method is generally only useful with a label position of w, which is the default. 💅

---

✨ COMPONENTS ✨

• Name: label · Class: label — the label component provides the label for the labeled widget. see the "label" widget manual entry for the details on the label component item. 🌸
• Name: lwchildsite · Class: frame — the lwchildsite component is the user child site for the labeled widget. see the "frame" widget manual entry for the details on the lwchildsite component item. 🦋

---

✨ EXAMPLE ✨

the labeledwidget was primarily meant to be a base class. ScrolledListBox and EntryField are good examples of derived classes of the labeledwidget class. in order to provide equal support for composite classes, the childsite method also exists. here's an example of childsite method usage, verbatim, no cap:

package require Iwidgets 4.0
iwidgets::labeledwidget .lw -labeltext "Canvas Widget" -labelpos s
pack .lw -fill both -expand yes -padx 10 -pady 10

set cw [canvas [.lw childsite].c -relief raised -width 200 -height 200]
pack $cw -padx 10 -pady 10

---

✨ AUTHOR ✨

Mark L. Ulferts — thank you for your service, king. 🫡

---

✨ KEYWORDS ✨

labeledwidget, widget

---

okay that's the whole page, bestie, you ate that. this one comes to you straight from the Tk manual, page iwidgets::labeledwidget(1), section 1 — that's the source and the version right there in the footer, no extra date tea, so don't come for me. go build something cute with it. mwah. 💋🎀