iwidgets::optionmenu(1)

💖 iwidgets::optionmenu 💖

okay so real talk: this is the manual page for iwidgets::optionmenu, and it lives in section 1 of the manual, and it comes from the [incr Widgets] family. She's giving very much "I make dropdown menus and I make them cute." Let's get into it bestie 🎀

---

✨ NAME ✨

iwidgets::optionmenu — create and manipulate an option menu widget 💅

---

✨ SYNOPSIS ✨

iwidgets::optionmenu pathName ?options?

---

🌈 INHERITANCE 🌈

itk::Widget <- iwidgets::Labeledwidget <- iwidgets::Optionmenu

that's the whole family tree, no cap 🧚

---

🌸 STANDARD OPTIONS 🌸

these are the classics, the ones every widget shows up with:

• activeBackground
• activeBorderWidth
• activeForeground
• background
• borderWidth
• cursor
• disabledForeground
• font
• foreground
• highlightColor
• highlightThickness
• relief

See the options manual entry for the details on all of these, bestie — she's not gonna re-explain them here. 📖

---

💜 INHERITED OPTIONS 💜

these ones she got from her ancestors:

• disabledForeground
• labelBitmap
• labelFontlabelImage
• labelMargin
• labelPos
• labelText
• labelVariable
• state
• sticky

See the LabeledWidget manual entry for the details on the inherited options.

lowkey obsessed that the page prints labelFontlabelImage as one giant word — yes, that's exactly how it's printed here, I'm not touching it 🫶

---

🦋 WIDGET-SPECIFIC OPTIONS 🦋

okay here's where she gets specific. Each one below has a Name, a Class, and a Command-Line Switch.

• -clicktime — Name: clickTime, Class: ClickTime. This is the interval time, in msec, used to figure out that a single mouse click has actually occurred. It's used to post the menu on a "quick" mouse click. ⚠️ Note: changing this value may cause the single-click functionality to not work properly. The default is 150 msec.
• -command — Name: command, Class: Command. Specifies a Tcl command procedure to be evaluated after the current option menu selection changes. iykyk, that's your callback ✨
• -cyclicon — Name: cyclicOn, Class: CyclicOn. Turns on/off the 3rd mouse button capability. The value may be specified in any of the forms acceptable to Tcl_GetBoolean. This feature lets the right mouse button cycle through the popup menu list without popping it up. The right mouse button cycles through the menu in reverse order. The default is true. 🔥
• -popupcursor — Name: popupCursor, Class: Cursor. Specifies the mouse cursor to be used for the popup menu. The value may have any of the forms acceptable to Tk_GetCursor. cursor glow-up, periodt 💅
• -state — Name: state, Class: State. Specifies one of two states for the optionmenu: normal or disabled. If the optionmenu is disabled, then option menu selection is ignored. 💀
• -width — Name: width, Class: Width. Specifies a fixed size for the menu button label, in any of the forms acceptable to Tk_GetPixels. If the text is too small to fit in the label, the text gets clipped. ⚠️ Note: normally, when a new list is created, or new items are added to an existing list, the menu button label is resized automatically — setting this option overrides that functionality. main character energy, she does what she wants 👑

---

✨ DESCRIPTION ✨

The iwidgets::optionmenu command creates an option menu widget with options to manage it. An option menu displays a frame containing a label and a button, and a pop-up menu will allow for the value of the button to change. it's giving dropdown but make it fashion 🎀

---

🌟 METHODS 🌟

The iwidgets::optionmenu 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.

Many of the widget commands for an optionmenu take as one argument an indicator of which entry of the option menu to operate on. These indicators are called indexes and may be specified in any of the following forms:

• number — Specifies the entry numerically, where 0 corresponds to the top-most entry of the option menu, 1 to the entry below it, and so on.
• end — Indicates the bottommost entry in the menu. If there are no entries in the menu then -1 is returned.
• select — Returns the numerical index of the currently selected option menu entry. If no entries exist in the menu, then -1 is returned.
• pattern — If the index doesn't satisfy one of the above forms then this form is used. Pattern is pattern-matched against the label of each entry in the option menu, in order from the top down, until a matching entry is found. The rules of Tcl_StringMatch are used.

The following widget commands are possible for optionmenu widgets: 🫶

---

💖 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::optionmenu command.
• 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::optionmenu command.
• pathName delete first ?last? — Delete all of the option menu entries between first and last inclusive. If last is omitted then it defaults to first. bye bestie 👋
• pathName disable index — Disable the option menu entry specified by index. Disabling a menu item will prevent the user from being able to select this item from the menu. This only effects the state of the item in the menu — in other words, should the item be the currently selected item, the programmer is responsible for determining this condition and taking appropriate action. 👀 so yes, that's on you
• pathName enable index — Enable the option menu entry specified by index. Enabling a menu item allows the user to select this item from the menu.
• pathName get ?first? ?last? — If no arguments are specified, this operation returns the currently selected option menu item. Otherwise, it returns the name of the option at index first, or a range of options between first and last.
• pathName index index — Returns the numerical index corresponding to index.
• pathName insert index string ?string? — Insert an item, or list of items, into the menu at location index.
• pathName select index — Select an item from the option menu to be displayed as the currently selected item.
• pathName sort mode — Sort the current menu in either ascending, or descending order. The values increasing, or decreasing are also accepted.

---

🧚 COMPONENTS 🧚

• menuBtn — Class: Menubutton. The menuBtn component is the option menu button which displays the current choice from the popup menu. See the menubutton widget manual entry for details on the menuBtn component item.
• popupMenu — Class: Menu. The popupMenu component is the menu displayed upon selection of the menu button. The menu contains the choices for the option menu. See the menu widget manual entry for details on the popupMenu component item.

---

⭐ EXAMPLE ⭐

package require Iwidgets 4.0
iwidgets::optionmenu .om -labelmargin 5 \
    -labelon true -labelpos w -labeltext "Operating System :"

.om insert end Unix VMS Linux OS/2 {Windows NT} DOS
.om sort ascending
.om select Linux

pack .om  -padx 10 -pady 10

ate that example fr fr 🔥

---

🌈 ACKNOWLEDGEMENTS: 🌈

• Michael J. McLennan — Borrowed some ideas (next & previous) from OptionButton class.
• Steven B. Jaggers — Provided an initial prototype in [incr Tcl].
• Bret Schuhmacher — Helped with popup menu functionality.

---

👑 AUTHOR 👑

Alfredo Jahn

---

🌸 KEYWORDS 🌸

optionmenu, widget

---

okay that's the whole page bestie, every single option and method and index form accounted for 💖 this was shipped out from the Tk corner of the world as page iwidgets::optionmenu(1) — go forth and build cute dropdowns, you're gonna slay ✨🎀🦋