XMMENUSHELL(3)

💖 XmMenuShell(3) 💖

okay so bestie, meet XmMenuShell — the MenuShell widget class. It's a custom OverrideShell widget, and it's literally built to hold Popup or Pulldown menu panes. The vibes? Immaculate. Let's go 🫶

---

✨ NAME ✨

XmMenuShell — The MenuShell widget class 👑

🌸 SYNOPSIS 🌸

#include <Xm/MenuShell.h>

💅 DESCRIPTION 💅

The MenuShell widget is a custom OverrideShell widget. An OverrideShell widget bypasses mwm when displaying itself. It is designed specifically to contain Popup or Pulldown menu panes.

Most application writers never encounter this widget if they use the menu-system convenience functions, XmCreatePopupMenu or XmCreatePulldownMenu, to create a Popup or Pulldown menu pane. The convenience functions automatically create a MenuShell widget as the parent of the menu pane. However, if the convenience functions are not used, the application programmer must create the required MenuShell. In this case, it is important to note that the parent of the MenuShell depends on the type of menu system being built.

• If the MenuShell is for the top-level Popup menu pane, the MenuShell's parent must be the widget from which the Popup menu pane is popped up.
• If the MenuShell is for a menu pane that is pulled down from a Popup or another Pulldown menu pane, the MenuShell's parent must be the Popup or Pulldown menu pane.
• If the MenuShell is for a menu pane that is pulled down from a MenuBar, the MenuShell's parent must be the MenuBar.
• If the MenuShell is for a Pulldown menu pane in an OptionMenu, the MenuShell's parent must be the OptionMenu's parent.

Setting XmNheight, XmNwidth, or XmNborderWidth for either a MenuShell or its child sets that resource to the same value in both the parent and the child. An application should always specify these resources for the child, not the parent.

For the managed child of a MenuShell, regardless of the value of the shell's XmNallowShellResize, setting XmNx or XmNy sets the corresponding resource of the parent but does not change the child's position relative to the parent. XtGetValues for the child's XmNx or XmNy yields the value of the corresponding resource in the parent. The x and y-coordinates of the child's upper left outside corner relative to the parent's upper left inside corner are both 0 (zero) minus the value of XmNborderWidth.

MenuShell uses the XmQTmenuSystem trait and holds the XmQTspecifyRenderTable trait.

🎀 Classes 🎀

MenuShell inherits behavior, resources, and traits from Core, Composite, Shell, and OverrideShell.

The class pointer is xmMenuShellWidgetClass.

The class name is XmMenuShell.

✨ New Resources ✨

MenuShell overrides the XmNallowShellResize resource in Shell. The following table defines a set of widget resources used by the programmer to specify data. The programmer can also set the resource values for the inherited classes to set attributes for this widget. To reference a resource by name or by class in a .Xdefaults file, remove the XmN or XmC prefix and use the remaining letters. To specify one of the defined values for a resource in a .Xdefaults file, remove the Xm prefix and use the remaining letters (in either lowercase or uppercase, but include any underscores between words). The codes in the access column indicate if the given resource can be set at creation time (C), set by using XtSetValues (S), retrieved by using XtGetValues (G), or is not applicable (N/A).

💖 XmMenuShell Resource Set 💖

• XmNbuttonFontList — Class: XmCButtonFontList · Type: XmFontList · Default: dynamic · Access: CSG
• XmNbuttonRenderTable — Class: XmCButtonRenderTable · Type: XmRenderTable · Default: NULL · Access: CSG
• XmNdefaultFontList — Class: XmCDefaultFontList · Type: XmFontList · Default: dynamic · Access: CG
• XmNlabelFontList — Class: XmCLabelFontList · Type: XmFontList · Default: dynamic · Access: CSG
• XmNlabelRenderTable — Class: XmCLabelRenderTable · Type: XmRenderTable · Default: NULL · Access: CSG
• XmNlayoutDirection — Class: XmCLayoutDirection · Type: XmDirection · Default: XmLEFT_TO_RIGHT · Access: CG
• XmNanimate — Class: XmCAnimate · Type: Boolean · Default: False · Access: CG

🦋 Resource Descriptions 🦋

• XmNbuttonFontList — Specifies the font list used for button descendants. See the XmNbuttonRenderTable resource.
• XmNbuttonRenderTable — Specifies the render table used for MenuShell's button descendants. If this value is NULL at initialization and if the value of XmNdefaultFontList is not NULL, XmNbuttonRenderTable is initialized to the value of XmNdefaultFontList. If the value of XmNdefaultFontList is NULL, XmNbuttonRenderTable is initialized by looking up the parent hierarchy of the widget for an ancestor that holds the XmQTspecifyRenderTable trait. If such an ancestor is found, XmNbuttonRenderTable is initialized to the XmBUTTON_RENDER_TABLE value of the ancestor widget. If no such ancestor is found, the default is implementation dependent. Refer to XmRenderTable(3) for more information on the creation and structure of a render table.
• XmNdefaultFontList — Specifies a default font list for MenuShell's descendants. This resource is obsolete and exists for compatibility with earlier releases. It has been replaced by XmNbuttonFontList and XmNlabelFontList.
• XmNlabelFontList — Specifies the font list used for label descendants. See the XmNlabelRenderTable resource.
• XmNlabelRenderTable — Specifies the render table used for MenuShell's label descendants (Labels and LabelGadgets). If this value is NULL at initialization and if the value of XmNdefaultFontList is not NULL, XmNlabelRenderTable is initialized to the value of XmNdefaultFontList. If the value of XmNdefaultFontList is NULL, the parent hierarchy of the widget is searched for an ancestor that holds the XmQTspecifyRenderTable trait. If such an ancestor is found, XmNlabelRenderTable is initialized to the XmLABEL_RENDER_TABLE value of the ancestor widget. If no such ancestor is found, the default is implementation dependent. Refer to XmRenderTable(3) for more information on the creation and structure of a render table.
• XmNlayoutDirection — Specifies the direction in which the subwidgets, children of a widget, or other visual components are to be laid out. This policy will apply as the default layout policy for all descendants of this MenuShell.
• XmNanimate — Controls whether menus will post in an animated fashion.

🦋 Inherited Resources 🦋

MenuShell inherits behavior and resources from the superclasses described in the following tables. For a complete description of each resource, refer to the reference page for that superclass. The programmer can set the resource values for these inherited classes to set attributes for this widget. To reference a resource by name or by class in a .Xdefaults file, remove the XmN or XmC prefix and use the remaining letters. To specify one of the defined values for a resource in a .Xdefaults file, remove the Xm prefix and use the remaining letters (in either lowercase or uppercase, but include any underscores between words). The codes in the access column indicate if the given resource can be set at creation time (C), set by using XtSetValues (S), retrieved by using XtGetValues (G), or is not applicable (N/A).

💅 Shell Resource Set 💅

okay bestie, here's the whole Shell resource set, every single one, no skips, no cap. For each one I'm giving you the name, the class, the type, the default, and the access code — exactly like the original says, just with way more ✨energy✨.

• XmNallowShellResize — class XmCAllowShellResize, type Boolean, default True, access G. she's permissive and she's defaulting to yes 💚
• XmNcreatePopupChildProc — class XmCCreatePopupChildProc, type XtCreatePopupChildProc, default NULL, access CSG.
• XmNgeometry — class XmCGeometry, type String, default NULL, access CSG. a whole string, and it starts out empty, iconic
• XmNoverrideRedirect — class XmCOverrideRedirect, type Boolean, default True, access CSG. 🦋
• XmNpopdownCallback — class XmCCallback, type XtCallbackList, default NULL, access C.
• XmNpopupCallback — class XmCCallback, type XtCallbackList, default NULL, access C.
• XmNsaveUnder — class XmCSaveUnder, type Boolean, default True, access CSG. defaults to True, saving that under, we love a prepared queen 🌸
• XmNvisual — class XmCVisual, type Visual *, default CopyFromParent, access CSG. note the literal star in the type, bestie, it's Visual *, do not lose the star ⭐

fr fr, those little access letters (G, CSG, C) are part of the table and I'm keeping them exactly as they came, no edits, no opinions, no guessing 💀

---

✨ Composite Resource Set ✨

and now the Composite resource set, only three of them, short and sweet, main character energy 👑

• XmNchildren — class XmCReadOnly, type WidgetList, default NULL, access G. read-only and giving nothing but a NULL default 🎀
• XmNinsertPosition — class XmCInsertPosition, type XtOrderProc, default NULL, access CSG.
• XmNnumChildren — class XmCReadOnly, type Cardinal, default 0, access G. zero, as in no children yet, we're manifesting 🫶

and yes, XmNchildren and XmNnumChildren are both read-only (G), while XmNinsertPosition is CSG — that's literally what the table says, iykyk 🧚

---

🌈 Core Resource Set 🌈

okay bestie, here's the whole core resource lineup — every single one, no skips, I promise 💖 Each bullet gives you the resource name, its class, its type, its default, and its access. That's the whole vibe check, five for five, every time.

• XmNaccelerators — class XmCAccelerators, type XtAccelerators, default dynamic, access CSG ✨
• XmNancestorSensitive — class XmCSensitive, type Boolean, default dynamic, access G
• XmNbackground — class XmCBackground, type Pixel, default dynamic, access CSG 🎀
• XmNbackgroundPixmap — class XmCPixmap, type Pixmap, default XmUNSPECIFIED_PIXMAP, access CSG
• XmNborderColor — class XmCBorderColor, type Pixel, default XtDefaultForeground, access CSG
• XmNborderPixmap — class XmCPixmap, type Pixmap, default XmUNSPECIFIED_PIXMAP, access CSG
• XmNborderWidth — class XmCBorderWidth, type Dimension, default 0, access CSG
• XmNcolormap — class XmCColormap, type Colormap, default dynamic, access CG 🌸
• XmNdepth — class XmCDepth, type int, default dynamic, access CG
• XmNdestroyCallback — class XmCCallback, type XtCallbackList, default NULL, access C
• XmNheight — class XmCHeight, type Dimension, default dynamic, access CSG
• XmNinitialResourcesPersistent — class XmCInitialResourcesPersistent, type Boolean, default True, access C 💅
• XmNmappedWhenManaged — class XmCMappedWhenManaged, type Boolean, default True, access CSG
• XmNscreen — class XmCScreen, type Screen *, default dynamic, access CG 🦋
• XmNsensitive — class XmCSensitive, type Boolean, default True, access CSG
• XmNtranslations — class XmCTranslations, type XtTranslations, default dynamic, access CSG
• XmNwidth — class XmCWidth, type Dimension, default dynamic, access CSG
• XmNx — class XmCPosition, type Position, default 0, access CSG
• XmNy — class XmCPosition, type Position, default 0, access CSG ⭐

---

✨ Translations ✨

The XmMenuShell translations live in the little list right below, and honestly? iconic. 👑

So the key names here follow the X standard key event translation table syntax — that's the exact format Motif uses to say which widget actions go with which key. If you want the quick-and-dirty overview of how that format works, go peek at VirtualBindings(3). And if you want the whole deep dive, fr fr, the place to be is the X Toolkit Instrinsics Documentation (yes, that spelling, I'm just relaying it bestie, don't come for me 😭).

<BtnDown>:
          ClearTraversal()

<BtnUp>:  MenuShellPopdownDone()

---

🎀 Action Routines 🎀

And these are the XmMenuShell action routines — the actual moves 💅

• ClearTraversal() — Disables keyboard traversal for the menu, enables mouse traversal, and unposts any menus that were posted by this menu. Basically: keyboard's out, mouse is in, and any menu this one popped up gets taken back down. 🫶
• MenuShellPopdownDone() — Unposts the whole menu hierarchy, and when the shell's keyboard focus policy is XmEXPLICIT, it restores focus right back to the widget that had focus before the menu system was ever entered. So it's giving "rewind, put it back exactly how you found it" energy. 🔥

🌸 MenuShellPopdownOne() 🌸

okay bestie, this one is THE un-post button and it behaves differently depending on where it lives, so pay attention 💅

• In a top-level Pulldown MenuPane from a MenuBar — it unposts the menu, disarms the MenuBar CascadeButton and the MenuBar, and, when the shell's keyboard focus policy is XmEXPLICIT, it restores keyboard focus to the widget that had the focus before the MenuBar was entered. it's giving "put it back exactly how you found it" ✨
• In other Pulldown MenuPanes — this action just unposts the menu. that's it. that's the whole job 🫶
• In a Popup MenuPane — it unposts the menu, and, when the shell's keyboard focus policy is XmEXPLICIT, it restores keyboard focus to the widget from which the menu was posted 🔥

---

✨ Virtual Bindings ✨

ngl, the bindings for virtual keys are vendor specific — so like, don't come for me, every vendor does their own thing 🙈

for the deets on bindings for virtual buttons and keys, go read VirtualBindings(3). iconic reference, go look 👑

---

💖 RELATED 💖

the whole friend group, no cap:

• Composite(3)
• Core(3)
• OverrideShell(3)
• Shell(3)
• XmCreateMenuShell(3)
• XmCreatePopupMenu(3)
• XmCreatePulldownMenu(3)
• XmRowColumn(3)

---

and that's a wrap on the whole page, bestie 🎀 this one's from the XmMenuShell(library call) family — that footer is literally the source/version tag, so if you're citing it, that's your receipt 💖 go forth and post and unpost those menus like the main character you are ✨👑