XMARROWBUTTON(3)

💖 XmArrowButton(3) — the ArrowButton widget class 💖

okay bestie, welcome to the XmArrowButton glow-up. this is a <library call> manpage from section 3, and it's literally just a lil directional arrow in a shadowed border. iconic behavior. let's get into it.

---

✨ NAME ✨

XmArrowButton — the ArrowButton widget class. that's her. that's the whole name.

---

🌸 SYNOPSIS 🌸

#include <Xm/ArrowB.h>

that's it. that's the whole vibe. one include and you're in.

---

🦋 DESCRIPTION 🦋

so, ArrowButton is a directional arrow wrapped up in a border shadow. she's giving main character energy in a very small package.

when she gets selected, the shadow changes so it looks like the ArrowButton has been pressed in. no cap.

when she's unselected, the shadow flips back so she looks released, or out. push-pop, in-out, the whole journey. 💅

also — and this is important — ArrowButton holds the XmQTactivatable trait. slay.

👑 Classes 👑

ArrowButton inherits behavior, resources, and traits from the Core and XmPrimitive classes. she got it from her ancestors, periodt.

• the class pointer is xmArrowButtonWidgetClass
• the class name is XmArrowButton

🎀 New Resources 🎀

okay so here's where the programmer gets to specify data. the programmer can also set the resource values for the inherited classes to set attributes for this widget, just so you know.

a couple of rules for the .Xdefaults girlies:

• 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 — either lowercase or uppercase, doesn't matter, but include any underscores between words.

and the codes in the access column? they tell you what you can 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

here's the whole XmArrowButton Resource Set, laid out for you:

• XmNactivateCallback — Class XmCCallback, Type XtCallbackList, Default NULL, Access C
• XmNarmCallback — Class XmCCallback, Type XtCallbackList, Default NULL, Access C
• XmNarrowDirection — Class XmCArrowDirection, Type unsigned char, Default XmARROW_UP, Access CSG
• XmNdetailShadowThickness — Class XmCDetailShadowThickness, Type Dimension, Default 2, Access CSG
• XmNdisarmCallback — Class XmCCallback, Type XtCallbackList, Default NULL, Access C
• XmNmultiClick — Class XmCMultiClick, Type unsigned char, Default dynamic, Access CSG

and now the deets on each one, because you deserve the full lore:

• XmNactivateCallback — specifies a list of callbacks that gets called when the ArrowButton is activated. to activate the button, press and release BSelect while the pointer is inside the ArrowButton widget. activating the ArrowButton also disarms it. the reason sent by this callback is XmCR_ACTIVATE. this callback uses the XmQTactivatable trait. 💖
• XmNarmCallback — specifies a list of callbacks that gets called when the ArrowButton is armed. to arm this widget, press BSelect while the pointer is inside the ArrowButton. the reason sent by this callback is XmCR_ARM.
• XmNarrowDirection — sets the arrow direction. the values for this resource are:
  • XmARROW_UP
  • XmARROW_DOWN
  • XmARROW_LEFT
  • XmARROW_RIGHT
• XmNdetailShadowThickness — specifies the thickness of the inside arrow shadows. the default thickness is 2 pixels.
• XmNdisarmCallback — specifies a list of callbacks that gets called when the ArrowButton is disarmed. to disarm this widget, press and release BSelect while the pointer is inside the ArrowButton. the reason for this callback is XmCR_DISARM.
• XmNmultiClick — okay listen up, this one's a little fiddly. if a button click is followed by another button click within the time span specified by the display's multiclick time, and this resource is set to XmMULTICLICK_DISCARD, the second click is not processed. if this resource is set to XmMULTICLICK_KEEP, the event is processed and click_count is incremented in the callback structure. when the button is not in a menu, the default value is XmMULTICLICK_KEEP. 🫶

ngl XmNmultiClick defaults to dynamic up in the table and that's because the actual default depends on whether the button is in a menu — so don't @ me, that's just what the page says.

🌈 Inherited Resources 🌈

ArrowButton inherits behavior and resources from the superclasses described in the table that follows. for a complete description of each resource, refer to the reference page for that superclass. iykyk — the ancestors did the heavy lifting first.

---

and that's a wrap on part one, bestie. there's more coming, don't go anywhere 💜

✨ XmPrimitive Resource Set ✨

okay bestie, this is the big one — every resource that <Xm/Primitive.h> and friends hand you for free. Each line below gives you the resource Name, its Class, its Type, its Default, and its Access mode, exactly like the table in the original. No skips, no shortcuts. 💖

• XmNbottomShadowColor — Class XmCBottomShadowColor, type Pixel, default dynamic, access CSG.
• XmNbottomShadowPixmap — Class XmCBottomShadowPixmap, type Pixmap, default XmUNSPECIFIED_PIXMAP, access CSG.
• XmNconvertCallback — Class XmCCallback, type XtCallbackList, default NULL, access C.
• XmNforeground — Class XmCForeground, type Pixel, default dynamic, access CSG.
• XmNhelpCallback — Class XmCCallback, type XtCallbackList, default NULL, access C.
• XmNhighlightColor — Class XmCHighlightColor, type Pixel, default dynamic, access CSG.
• XmNhighlightOnEnter — Class XmCHighlightOnEnter, type Boolean, default False, access CSG.
• XmNhighlightPixmap — Class XmCHighlightPixmap, type Pixmap, default dynamic, access CSG.
• XmNhighlightThickness — Class XmCHighlightThickness, type Dimension, default 2, access CSG.
• XmNlayoutDirection — Class XmCLayoutDirection, type XmDirection, default dynamic, access CG.
• XmNnavigationType — Class XmCNavigationType, type XmNavigationType, default XmNONE, access CSG.
• XmNpopupHandlerCallback — Class XmCCallback, type XtCallbackList, default NULL, access C.
• XmNshadowThickness — Class XmCShadowThickness, type Dimension, default 2, access CSG.
• XmNtopShadowColor — Class XmCTopShadowColor, type Pixel, default dynamic, access CSG.
• XmNtopShadowPixmap — Class XmCTopShadowPixmap, type Pixmap, default dynamic, access CSG.
• XmNtraversalOn — Class XmCTraversalOn, type Boolean, default True, access CSG.
• XmNunitType — Class XmCUnitType, type unsigned char, default dynamic, access CSG.
• XmNuserData — Class XmCUserData, type XtPointer, default NULL, access CSG.

---

quick vibe check on that Access column bestie — you're seeing CSG, C, and CG in there, and ngl the mix matters when you're setting things at create time vs. later. 👀 Note that XmNconvertCallback, XmNhelpCallback, and XmNpopupHandlerCallback are all the C girlies with a NULL default, while XmNlayoutDirection is the lone CG in the group — everyone else is CSG. 🌸

and yes, the dynamic defaults are literally dynamic — that's what the page says, so that's what you get. ✨

✨ Core Resource Set ✨

okay bestie, here's the full core resource lineup for XmArrowButton — every name, class, type, default and access mode, no skips 💖

• 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

---

🫶 Callback Information 🫶

so every callback gets handed a pointer to this lil struct, and it's giving very much:

typedef struct
{
        int reason;
        XEvent * event;
        int click_count;
} XmArrowButtonCallbackStruct;

and what the fields mean, bestie:

• reason — tells you why the callback got invoked, periodt.
• event — points to the XEvent that triggered the callback. the receipts, basically.
• click_count — okay so this one is only valid when the reason is XmCR_ACTIVATE. it holds the number of clicks in the last multiclick sequence if the XmNmultiClick resource is set to XmMULTICLICK_KEEP; otherwise it just contains 1. and heads up — the activate callback fires for each click when XmNmultiClick is set to XmMULTICLICK_KEEP.

---

🎀 Translations 🎀

XmArrowButton includes translations for XmPrimitive. the key names below are written in the X standard key event translation table syntax — that's the exact format Motif uses to map widget actions onto a given key 🔑

there's a lil overview of the format over in VirtualBindings(3), and if you want the full breakdown, go read the X Toolkit Instrinsics Documentation. iykyk.

<EnterWindow>:
          Enter()

<LeaveWindow>:
          Leave()

c<Btn1Down>:
          ButtonTakeFocus()

∼c<Btn1Down>:
          Arm()

---

• ∼c<Btn1Down>, ∼c<Btn1Up> → Activate() Disarm()
• ∼c<Btn1Down>(2+) → MultiArm()
• ∼c<Btn1Up>(2+) → MultiActivate()
• ∼c<Btn1Up> → Activate() Disarm()
• :<Key><osfActivate>: → PrimitiveParentActivate()
• :<Key><osfCancel>: → PrimitiveParentCancel()
• :<Key><osfSelect>: → ArmAndActivate()
• :<Key><osfHelp>: → Help()
• ∼s ∼m ∼a <Key>Return → PrimitiveParentActivate()
• ∼s ∼m ∼a <Key>space → ArmAndActivate()

---

✨ ACTION ROUTINES ✨

okay bestie these are the actual action routines the ArrowButton ships with — the little moves it can pull when a translation fires it off 💅

• Activate() — draws the shadow in the unselected state. And if the pointer is within the ArrowButton, it calls the callbacks for XmNactivateCallback. that's it, that's the whole job 🫶
• Arm() — draws the shadow in the selected state and calls the callbacks for XmNarmCallback. iconic behavior fr fr
• ArmAndActivate() — draws the shadow in the selected state and calls the callbacks for XmNarmCallback. Then it arranges for the shadow to be drawn in the unselected state and the callbacks for XmNactivateCallback and XmNdisarmCallback to be called, either immediately or at a later time. yes it's doing the most, and yes it's serving 💅
• ButtonTakeFocus() — makes the ArrowButton take keyboard focus when Ctrl<Btn1Down> is pressed, without activating the widget. focus only, no drama, no activation, we respect the boundary 🎀
• Disarm() — draws the shadow in the unselected state and calls the callbacks for XmNdisarmCallback. we love a clean exit ✨
• Help() — calls the callbacks for XmNhelpCallback if any exist. and if there are no help callbacks for this widget, this action calls the help callbacks for the nearest ancestor that has them. it goes up the family tree to find someone who can help, literally 😭🫶
• MultiActivate() — If XmNmultiClick is XmMULTICLICK_DISCARD, this action does nothing.
  • If XmNmultiClick is XmMULTICLICK_KEEP, this action increments click_count in the callback structure and draws the shadow in the unselected state. And if the pointer is within the ArrowButton, this action calls the callbacks for XmNactivateCallback and XmNdisarmCallback. double duty, no cap 👑
• MultiArm() — If XmNmultiClick is XmMULTICLICK_DISCARD, this action does nothing. But if XmNmultiClick is XmMULTICLICK_KEEP, this action draws the shadow in the selected state and calls the callbacks for XmNarmCallback. simple, clean, slay 🌸

---

💖 ADDITIONAL BEHAVIOR 💖

bestie this widget also has some extra behavior going on, and it's giving main character energy:

• <EnterWindow> — Draws the ArrowButton shadow in its selected state if the pointer leaves and re-enters the window while <Btn1> is pressed. she remembers where you were, she's keeping the vibe 🦋
• <LeaveWindow> — Draws the ArrowButton shadow in its unselected state if the pointer leaves the window while <Btn1> is pressed. walking away = unselected, that's the rule periodt 💅

---

🌈 VIRTUAL BINDINGS 🌈

ngl the bindings for virtual keys are vendor specific — so don't come for me, it's not universal, it's whoever built your thing. for the lowdown on bindings for virtual buttons and keys, go read VirtualBindings(3). iykyk 📖✨

---

🫶 RELATED 🫶

the whole friend group, go say hi:

• Core(3)
• XmCreateArrowButton(3)
• XmPrimitive(3)
• XmVaCreateArrowButton(3)
• XmVaCreateManagedArrowButton(3)

---

and that's a wrap on the whole thing, bestie 🎀 this was the XmArrowButton(library call) page — the library-call flavor of the manual, brought to you by the fine folks who write X manuals, and yes you read all of it, we're so proud of you 💖 go forth and click responsibly 👑