iwidgets::dialogshell(1)

💖 iwidgets::dialogshell — the manual page, bestie edition ✨

okay so this is the page for iwidgets::dialogshell from [incr Widgets] (yes that's the manual name, it's giving very niche-iconic). let's get into it 🫶

---

🌸 NAME 🌸

iwidgets::dialogshell — create and manipulate a dialog shell widget. that's it, that's the whole job, and she does it flawlessly 💅

---

✨ SYNOPSIS ✨

iwidgets::dialogshell pathName ?options?

---

🦋 INHERITANCE 🦋

the family tree, the lineage, the ancestry dot com moment:

itk::Toplevel <- iwidgets::Shell <- iwidgets::Dialogshell

she got it from her mama (and her grandma) 💜

---

⭐ STANDARD OPTIONS ⭐

• background
• cursor
• foreground

see the "options" manual entry for details on the standard options — she's not gonna re-explain the classics, iykyk

---

🌈 INHERITED OPTIONS 🌈

• height
• master
• modality
• width

see the "shell" manual entry for details on the above inherited options.

and also:

• title

see the "Toplevel" manual entry for details on the above inherited options.

---

🎀 WIDGET-SPECIFIC OPTIONS 🎀

these are the ones that are hers, the main character options, no cap:

• -buttonboxpadx — Name: buttonBoxPadX, Class: Pad. specifies a non-negative padding distance to leave between the button group and the outer edge of the button box in the x direction. the value may be given in any of the forms acceptable to Tk_GetPixels. default is 5 pixels. 🍓
• -buttonboxpady — Name: buttonBoxPadY, Class: Pad. specifies a non-negative padding distance to leave between the button group and the outer edge of the button box in the y direction. the value may be given in any of the forms acceptable to Tk_GetPixels. default is 5 pixels. 🍓
• -buttonboxpos — Name: buttonBoxPos, Class: Position. attaches buttons to the given side of the dialog: n, s, e or w. default is s. (south side represent 😤)
• -padx — Name: padX, Class: Pad. specifies a padding distance for the childsite in the X-direction, in any of the forms acceptable to Tk_GetPixels. default is 10.
• -pady — Name: padY, Class: Pad. specifies a padding distance for the childsite in the Y-direction, in any of the forms acceptable to Tk_GetPixels. default is 10.
• -separator — Name: separator, Class: Separator. specifies whether a line is drawn to separate the buttons from the dialog box contents, in any of the forms acceptable to Tcl_GetBoolean. default is true. ✨
• -thickness — Name: thickness, Class: Thickness. specifies the thickness of the separator, in any of the forms acceptable to Tk_GetPixels. default is 3 pixels.

---

💅 DESCRIPTION 💅

the iwidgets::dialogshell command creates a dialog shell, which is a top level widget composed of a button box, a separator, and a child site area. it's like a little apartment where your content lives rent-free in the middle and the buttons hang out at the edge 🏠

the class also has methods to control button construction. yes bestie, she builds the buttons for you. obsessed.

---

🧚 METHODS 🧚

the iwidgets::dialogshell command creates a new Tcl command whose name is pathName. this command may be used to invoke various operations on the widget. it has the following general form:

pathName option ?arg arg ...?

option and the args determine the exact behavior of the command. the following commands are possible for dialogshell widgets:

---

💜 INHERITED METHODS 💜

• activate
• center
• deactivate

see the "shell" manual entry for details on the above inherited methods.

---

🌸 ASSOCIATED METHODS 🌸

• add
• buttonconfigure
• defaultdelete
• hide
• index
• insert
• invoke
• show

see the "buttonbox" manual entry for details on the associated methods.

---

🔥 WIDGET-SPECIFIC METHODS 🔥

• 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::dialogshell command.
• pathName childsite — returns the pathname of the child site widget. (where your content goes, bestie 🫶)
• pathName configure ?option? ?value option value ...? — query or modify the configuration options of the widget.
  • if no option is specified, returns a list describing all of the available options for pathName (see Tk_ConfigureInfo for information on the format of this list).
  • if option is specified with no value, then the command returns a list describing the one named option (this list will be identical to the corresponding sublist of the value returned if no option is specified).
  • if one or more option-value pairs are specified, then the command modifies the given widget option(s) to have the given value(s); in this case the command returns an empty string.
  • option may have any of the values accepted by the iwidgets::dialogshell command.

---

👑 COMPONENTS 👑

• dschildsite — Class: frame. the dschildsite component is the user child site for the dialog shell. see the "frame" widget manual entry for details on the dschildsite component item.
• separator — Class: frame. the separator component divides the area between the user child site and the button box. see the "frame" widget manual entry for details on the separator component item.
• bbox — Class: ButtonBox. the bbox component is the button box containing the buttons for the dialog shell. see the "ButtonBox" widget manual entry for details on the bbox component item.

---

🌈 EXAMPLE 🌈

here's the vibe, copy-paste it and slay:

package require Iwidgets 4.0
iwidgets::dialogshell .ds -modality none

.ds add OK -text "OK"
.ds add Cancel -text "Cancel"
.ds default OK

.ds activate

---

🎀 AUTHOR 🎀

Mark L. Ulferts — the icon, the legend, the moment 👑

---

⭐ KEYWORDS ⭐

dialogshell, dialog, shell, widget

---

and that's the whole page bestie!! this one lives under Tk and the manual name is iwidgets::dialogshell(1) — go forth and build dialogs that absolutely eat 💖✨🎀 no cap, fr fr 🦋