WMSHELL(3)

🌸 WMShell — bestie, it's a whole widget class 🌸

okay so this is the manual page for WMShell, the WMShell widget class, and we are gonna get through it together. it's long. it's giving ✨reference material✨. but it's so worth it, i promise. 💖

---

✨ NAME ✨

WMShell — The WMShell widget class

periodt. that's her. that's the name. 🎀

---

💅 SYNOPSIS 💅

#include <Xm/Xm.h>
#include <X11/Shell.h>

like yes, you include both. no you cannot skip one. bestie the second one is literally where the shell stuff lives. 🙈

---

🦋 DESCRIPTION 🦋

so WMShell is a top-level widget — main character energy, obviously — and what she does is encapsulate the interaction with the window manager. that's the whole vibe. she's the one talking to the WM so you don't have to. 💅

🧚 Classes 🧚

WMShell inherits behavior and resources from the Core, Composite, and Shell classes. so she's got layers. she's complex. she's a whole family tree. 🌸

the class pointer is wmShellWidgetClass.

the class name is WMShell.

ngl, remembering which one is the pointer and which one is the name is the whole game. pointer = lowercase-first wmShellWidgetClass. class name = WMShell. don't mix them up, bestie. 😭

👑 New Resources 👑

okay here's the big one. 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. so you're not locked out of the family resources — you get those too. 💜

here's the lil cheat code for your .Xdefaults file, and it's genuinely iconic:

• 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. don't forget the underscores. fr fr.

and the codes in the access column? they tell you what you're allowed to do with the resource:

• C — can be set at creation time
• S — can be set by using XtSetValues
• G — can be retrieved by using XtGetValues
• N/A — not applicable

so CSG means all three, slay. 🔥

🌈 WMShell Resource Set 🌈

• XmNbaseHeight / XmCBaseHeight — type int, default XtUnspecifiedShellInt, access CSG
• XmNbaseWidth / XmCBaseWidth — type int, default XtUnspecifiedShellInt, access CSG
• XmNheightInc / XmCHeightInc — type int, default XtUnspecifiedShellInt, access CSG
• XmNiconMask / XmCIconMask — type Pixmap, default NULL, access CSG
• XmNiconPixmap / XmCIconPixmap — type Pixmap, default NULL, access CSG
• XmNiconWindow / XmCIconWindow — type Window, default NULL, access CSG
• XmNiconX / XmCIconX — type int, default XtUnspecifiedShellInt, access CSG
• XmNiconY / XmCIconY — type int, default XtUnspecifiedShellInt, access CSG
• XmNinitialState / XmCInitialState — type int, default NormalState, access CSG
• XmNinput / XmCInput — type Boolean, default False, access CSG
• XmNmaxAspectX / XmCMaxAspectX — type int, default XtUnspecifiedShellInt, access CSG
• XmNmaxAspectY / XmCMaxAspectY — type int, default XtUnspecifiedShellInt, access CSG
• XmNmaxHeight / XmCMaxHeight — type int, default XtUnspecifiedShellInt, access CSG
• XmNmaxWidth / XmCMaxWidth — type int, default XtUnspecifiedShellInt, access CSG
• XmNminAspectX / XmCMinAspectX — type int, default XtUnspecifiedShellInt, access CSG
• XmNminAspectY / XmCMinAspectY — type int, default XtUnspecifiedShellInt, access CSG
• XmNminHeight / XmCMinHeight — type int, default XtUnspecifiedShellInt, access CSG
• XmNminWidth / XmCMinWidth — type int, default XtUnspecifiedShellInt, access CSG
• XmNtitle / XmCTitle — type String, default dynamic, access CSG
• XmNtitleEncoding / XmCTitleEncoding — type Atom, default dynamic, access CSG
• XmNtransient / XmCTransient — type Boolean, default False, access CSG
• XmNwaitForWm / XmCWaitForWm — type Boolean, default True, access CSG
• XmNwidthInc / XmCWidthInc — type int, default XtUnspecifiedShellInt, access CSG
• XmNwindowGroup / XmCWindowGroup — type Window, default dynamic, access CSG
• XmNwinGravity / XmCWinGravity — type int, default dynamic, access CSG
• XmNwmTimeout / XmCWmTimeout — type int, default 5000 ms, access CSG

lowkey notice how every single one of them is CSG? yeah. you can create it, XtSetValues it, and XtGetValues it. every last one. iconic behavior honestly. 👑

and that's it for the resource set — no more rows hiding anywhere, i counted twice. 🌟

• XmNbaseHeight — the ✨base✨ of a whole lil' progression of preferred heights that the window manager can use when it sizes this widget. So the preferred heights are XmNbaseHeight plus integral multiples of XmNheightInc, minimum XmNminHeight, maximum XmNmaxHeight. And if you don't give it an initial value but you do give one for XmNbaseWidth, then XmNbaseHeight gets set to 0 (zero) at the moment the widget is realized. iykyk 💅
• XmNbaseWidth — same energy, but for widths, bestie 🫶 It's the base for a progression of preferred widths the window manager uses to size the widget. Preferred widths = XmNbaseWidth plus integral multiples of XmNwidthInc, min XmNminWidth, max XmNmaxWidth. If no initial value is supplied for XmNbaseWidth but one is supplied for XmNbaseHeight, then XmNbaseWidth is set to 0 (zero) when the widget is realized. Mirror moment, iconic.
• XmNheightInc — the increment 🎀 for that progression of preferred heights the window manager uses in sizing. Preferred heights are XmNbaseHeight plus integral multiples of XmNheightInc, with a minimum of XmNminHeight and a maximum of XmNmaxHeight. If no initial value is supplied for XmNheightInc but one is supplied for XmNwidthInc, then XmNheightInc is set to 1 when the widget is realized. not the default being 1 instead of 0, the way it's giving consistency 😭
• XmNiconMask — specifies a bitmap that could be used by the window manager to clip the XmNiconPixmap bitmap, so the icon can be nonrectangular. slay 💅
• XmNiconPixmap — specifies a bitmap that could be used by the window manager as the application's icon. cute.
• XmNiconWindow — specifies the ID of a window that could be used by the window manager as the application's icon. window-as-icon, main character energy ✨
• XmNiconX — a suitable place to put the application's icon; it's a hint to the window manager, in root window coordinates. ⚠️ And because the window manager controls icon placement policy, this resource may be ignored. lowkey just a suggestion fr fr.
• XmNiconY — same thing, the Y half of the vibe: a suitable place to put the application's icon, a hint to the window manager in root window coordinates. And again, the window manager owns icon placement policy, so this resource may be ignored. 🙈
• XmNinitialState — the state the application wants the widget instance to start in. It must be one of the constants NormalState or IconicState. no third option, that's the whole menu 💀
• XmNinput — the application's input model for this widget and its descendants. 👑 The meaning of a True or False value here depends on whether a WM_TAKE_FOCUS atom is present or absent in the WM_PROTOCOLS property. Here's the whole tea:
  • No input — XmNinput is False, WM_TAKE_FOCUS is Absent
  • Passive — XmNinput is True, WM_TAKE_FOCUS is Absent
  • Locally active — XmNinput is True, WM_TAKE_FOCUS is Present
  • Globally active — XmNinput is False, WM_TAKE_FOCUS is Present

For more info on input models, go read the X Consortium Standard Inter-Client Communication Conventions Manual (ICCCM). required reading bestie 📚

• XmNmaxAspectX — the numerator of the maximum aspect ratio (X/Y) the application wants the widget instance to have. 🦋
• XmNmaxAspectY — the denominator of the maximum aspect ratio (X/Y) the application wants the widget instance to have. the way X and Y are a whole couple 🌸
• XmNmaxHeight — the maximum height the application wants the widget instance to have.
• XmNmaxWidth — the maximum width the application wants the widget instance to have.
• XmNminAspectX — the numerator of the minimum aspect ratio (X/Y) the application wants the widget instance to have.
• XmNminAspectY — the denominator of the minimum aspect ratio (X/Y) the application wants the widget instance to have.
• XmNminHeight — the minimum height the application wants the widget instance to have.
• XmNminWidth — the minimum width the application wants the widget instance to have.
• XmNtitle — the application name the window manager displays. The default is the icon name, if specified; otherwise it's the name of the application. 🚨 And when XtGetValues is called on this resource, the returned value is a pointer to the actual resource value and should not be freed. do not free it bestie, I am begging you 😭
• XmNtitleEncoding — specifies a property type representing the encoding of the XmNtitle string. If a language procedure has been set, the default is None; otherwise the default is XA_STRING. When the widget is realized, if the value is None, the corresponding name is assumed to be in the current locale. The name is passed to XmbTextListToTextProperty with an encoding style of XStdICCTextStyle. The resulting encoding is STRING if the name is fully convertible to STRING; otherwise it's COMPOUND_TEXT. And the values of the encoding resources are not changed — they remain None. the way it stays None regardless 💅 iconic.
• XmNtransient — a Boolean that's True if the widget instance is transient, typically a popup on behalf of another widget. The window manager may treat a transient widget's window differently from other windows — for example, it may not iconify a transient window separately from its associated application. ⚠️ Applications and users should not normally alter this resource. hands off, bestie 🙅
• XmNwaitForWm — when True, it specifies that the Intrinsics waits the length of time given by the XmNwmTimeout resource for the window manager to respond to certain actions, before assuming there's no window manager present at all. This resource gets altered by the Intrinsics as it receives — or fails to receive — responses from the window manager. it updates itself, we love a self-aware queen ✨
• XmNwidthInc — the base for a progression of preferred widths the window manager uses in sizing the widget. The preferred widths are XmNbaseWidth plus integral multiples of XmNwidthInc, with a minimum of XmNminWidth and a maximum of XmNmaxWidth. If no initial value is supplied for XmNwidthInc but one is supplied for XmNheightInc, the value of XmNwidthInc is set to 1 when the widget is realized. yep, 1 again 🎀
• XmNwindowGroup — the ID of a window this widget instance is associated with. By convention, this window is the "leader" of a group of windows. 👑 A window manager may treat all the windows in a group some way — for example, it may always move or iconify them together. no cap.

If no initial value is specified, the value is set to the window of the first realized ancestor widget in the parent hierarchy when the widget is realized. And if a value of XtUnspecifiedWindowGroup is specified, no window group is set. 🌈

• XmNwinGravity — the window gravity for the window manager to use when positioning the widget. If no initial value is specified, the value is set when the widget is realized. If XmNgeometry is not NULL, XmNwinGravity is set to the window gravity returned by XWMGeometry. Otherwise, XmNwinGravity is set to NorthWestGravity. default corner behavior, so real of it 💅
• XmNwmTimeout — how long the Intrinsics waits for the window manager to respond to certain actions before assuming there is no window manager present. 🚨 The value is in milliseconds and must not be negative. fr fr, don't do it.

---

🧬 Inherited Resources (the family tree moment)

WMShell inherits behavior and resources from the superclasses described in the following tables. For a complete description of each resource, go read the reference page for that superclass. passing the vibe check up the hierarchy 🫶

💅 Shell Resource Set 💅

Okay bestie, here's the whole squad of resources the shell core brings to the party. Name, class, type, default, access — every single one of them, no skips, no cap. 🫶

• XmNallowShellResize — class XmCAllowShellResize, type Boolean, default False, access CG.
• XmNcreatePopupChildProc — class XmCCreatePopupChildProc, type XtCreatePopupChildProc, default NULL, access CSG.
• XmNgeometry — class XmCGeometry, type String, default NULL, access CSG.
• XmNoverrideRedirect — class XmCOverrideRedirect, type Boolean, default False, 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 False, access CSG.
• XmNvisual — class XmCVisual, type Visual *, default CopyFromParent, access CSG.

---

🌈 Composite Resource Set 🌈

And these are the ones the composite layer hands you — the little trio that manages the children situation. Very main character energy, very brief. ✨

• XmNchildren — class XmCReadOnly, type WidgetList, default NULL, access G.
• XmNinsertPosition — class XmCInsertPosition, type XtOrderProc, default NULL, access CSG.
• XmNnumChildren — class XmCReadOnly, type Cardinal, default 0, access G.

okay bestie, welcome to the resource era ✨ this is the whole Core Resource Set — every single one, no skips, no skimming, we are reading the whole menu 💅

🌸 Core Resource Set 🌸

Every resource gets its class, its type, its default, and its access — all of it, verbatim, because we do not leave details behind 🫶

• 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 🎀

And here's the plot twist bestie: there are no translations for WMShell. That's it. That's the whole tea. Not a single one. The vibe check came back empty 😭

---

🌈 RELATED 🌈

• Composite(3)
• Core(3)
• Shell(3)

go read those too, bestie, they're literally the friend group 👑

---

and that's the whole page, you ate it fr fr 💅✨ this one's a library call from WMShell — the source/version and date live on that little footer line down at the bottom of the page, so go give it a lil kiss for me 💖 slay, periodt, bye bestie 🦋