XMARROWBUTTONGADGET(3)

💖 XmArrowButtonGadget — the ArrowButtonGadget widget class 💖

okay so bestie, welcome to XmArrowButtonGadget(library call) — yes that's the manual page name, yes it's a mouthful, we're gonna get through it together 🫶

---

✨ NAME ✨

XmArrowButtonGadget — literally The ArrowButtonGadget widget class. that's it. that's the name. iconic behavior honestly 👑

---

🎀 SYNOPSIS 🎀

#include <Xm/ArrowBG.h>

---

🦋 DESCRIPTION 🦋

so picture this: an ArrowButtonGadget is a directional arrow, right, and it's surrounded by a border shadow. that's the whole vibe. 🌈

when it gets selected, the shadow changes so it looks like the ArrowButtonGadget has been pressed in. when it's unselected, the shadow reverts and it looks like the button is released, or out. the glow-up and the glow-down, basically. 💅

ArrowButtonGadget holds the XmQTactivatable trait. noted. important. don't forget it.

---

👯 Classes

ArrowButtonGadget inherits behavior, resources, and traits from the Object, RectObj, and XmGadget classes. it's giving nepo baby but make it inheritance hierarchy, and honestly? slay.

• The class pointer is xmArrowButtonGadgetClass.
• The class name is XmArrowButtonGadget.

---

⭐ New Resources ⭐

okay so the following table defines a set of widget resources used by the programmer to specify data. (yes i said table, we're doing it as a list because terminal, bear with me, all the info is here fr fr.)

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).

🌸 XmArrowButtonGadget Resource Set 🌸

• 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

---

💖 XmNactivateCallback

specifies a list of callbacks that is called when the ArrowButtonGadget is activated. to activate the button, press and release BSelect while the pointer is inside the ArrowButtonGadget. activating the ArrowButtonGadget 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 is called when the ArrowButtonGadget is armed. to arm this widget, press BSelect while the pointer is inside the ArrowButtonGadget. 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

pick your fighter. 👑

🍓 XmNdetailShadowThickness

specifies the thickness of the inside arrow shadows. the default thickness is 2 pixels. tiny but mighty.

🙈 XmNdisarmCallback

specifies a list of callbacks that is called when the ArrowButtonGadget is disarmed. to disarm this widget, press and release BSelect while the pointer is inside the ArrowButtonGadget. the reason sent by this callback is XmCR_DISARM.

🌈 XmNmultiClick

okay so 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 ArrowButtonGadget is not in a menu, the default value is XmMULTICLICK_KEEP.

no cap: XmMULTICLICK_DISCARD means that second click just gets ghosted 💀 the event does not go through. choose wisely.

---

🧚 Inherited Resources 🧚

XmArrowButtonGadget 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. (iykyk — the tables live on in the pages for those superclasses, go read those bestie, they're the whole lore) 💜

---

💖 XmGadget Resource Set 💖

okay bestie, before we even get to the arrow-button-specific stuff, every gadget inherits a whole mountain of resources from its ancestors. here's the XmGadget set — all of it, no skipping, no cap:

• XmNbackground — class XmCBackground, type Pixel, default dynamic, access CSG. the canvas behind everything 🎨
• XmNbackgroundPixmap — class XmCPixmap, type Pixmap, default XmUNSPECIFIED_PIXMAP, access CSG. wallpaper instead of a flat colour ✨
• XmNbottomShadowColor — class XmCBottomShadowColor, type Pixel, default dynamic, access CSG. the bottom shadow's whole vibe 💅
• XmNbottomShadowPixmap — class XmCBottomShadowPixmap, type Pixmap, default dynamic, access CSG. same energy, but as a pixmap 🦋
• XmNhelpCallback — class XmCCallback, type XtCallbackList, default NULL, access C. your help-me callback 🫶
• XmNforeground — class XmCForeground, type Pixel, default dynamic, access CSG. the ink, the front colour, the moment 🖋️
• 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 XmNCLayoutDirection, type XmDirection, default dynamic, access CG. and yes, the class is spelled exactly like that, type it character for character, don't get creative 😭
• XmNnavigationType — class XmCNavigationType, type XmNavigationType, default XmNONE, access CSG
• XmNshadowThickness — class XmCShadowThickness, type Dimension, default 2, access CSG
• XmNtopShadowColor — class XmCTopShadowColor, type Pixel, default dynamic, access CSG. top shadow, but make it colour 🌈
• XmNtopShadowPixmap — class XmCTopShadowPixmap, type Pixmap, default dynamic, access CSG. top shadow, but make it a pixmap 🌸
• 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. your personal lil stash, put whatever you want in there 🍓

---

🎀 RectObj Resource Set 🎀

and underneath that there's the RectObj set — the geometry girlies. every one of these, coming right up 👑

• XmNancestorSensitive — class XmCSensitive, type Boolean, default dynamic, access G
• XmNborderWidth — class XmCBorderWidth, type Dimension, default 0, access N/A
• XmNheight — class XmCHeight, type Dimension, default dynamic, access CSG
• XmNsensitive — class XmCSensitive, type Boolean, default True, 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

lowkey obsessed with how tidy that list is 💜 and we are so not done yet —

okay so last chunk of the resource table, and it is tiny — literally one entry, we love a low-effort slay 💅

Object Resource Set

• XmNdestroyCallback — class XmCCallback, type XtCallbackList, default NULL, access C. That's it, that's the whole set, bestie 🎀

---

🌸 Callback Information 🌸

Every callback gets handed a pointer to this exact lil struct, no cap:

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

• reason — spills the tea on why the callback got invoked in the first place.
• event — points at the XEvent that triggered the whole thing.
• click_count — heads up, this one only means anything when reason is XmCR_ACTIVATE. It holds the number of clicks in the last multiclick sequence if XmNmultiClick is set to XmMULTICLICK_KEEP — otherwise it's just 1. And lowkey important: if XmNmultiClick is XmMULTICLICK_KEEP, the activate callback fires for every single click, not just once.

---

🦋 Behavior 🦋

XmArrowButtonGadget inherits its whole vibe from XmGadget, obviously. But here's the extra stuff it does on its own:

• <Btn1Down> — draws the shadow in the selected state and calls the callbacks for XmNarmCallback. It's giving "I'm armed and ready" energy 😤
• <Btn1Down> or <Btn1Up> — draws the shadow in the unselected state. If the pointer is within the ArrowButtonGadget, it calls the callbacks for XmNactivateCallback. Also calls the callbacks for XmNdisarmCallback.
• <Btn1Down>(2+) — if XmNmultiClick is XmMULTICLICK_DISCARD, this action does absolutely nothing, fr. If XmNmultiClick is XmMULTICLICK_KEEP, it draws the shadow in the selected state and calls the callbacks for XmNarmCallback.
• <Btn1Up>(2+) — if XmNmultiClick is XmMULTICLICK_DISCARD, again, 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 ArrowButtonGadget, it calls the callbacks for XmNactivateCallback and XmNdisarmCallback.
• <Key><osfSelect> — draws the shadow in the selected state and calls the callbacks for XmNarmCallback. It also arranges for the shadow to be drawn in the unselected state, plus the callbacks for XmNactivateCallback and XmNdisarmCallback to get called — either immediately or at a later time. whenever it feels like it, iconic behavior ✨
• <Key><osfHelp> — calls the callbacks for XmNhelpCallback if any exist. If there are no help callbacks for this widget, this action goes and calls the help callbacks for the nearest ancestor that has them. passing the aux cord up the family tree 🫶
• <Enter> — draws the ArrowButtonGadget shadow in its selected state if the pointer leaves and re-enters the gadget while <Btn1> is pressed.
• <Leave> — draws the ArrowButtonGadget shadow in its unselected state if the pointer leaves the gadget while <Btn1> is pressed.

---

🧚 Virtual Bindings 🧚

The bindings for virtual keys are vendor specific — so it's a "your mileage may vary, ask your vendor" situation, ngl. For information about bindings for virtual buttons and keys, see VirtualBindings(3).

---

⭐ RELATED ⭐

The squad, the crew, the whole friend group 💜

• Object(3)
• RectObj(3)
• XmCreateArrowButtonGadget(3)
• XmGadget(3)
• XmVaCreateArrowButtonGadget(3)
• XmVaCreateManagedArrowButtonGadget(3)

---

and that's a wrap on XmArrowButtonGadget(library call) — straight out of the library-call corner of the Motif man pages, with its date and version living down at the bottom of the page. go forth and arrow-button, bestie, you ate 💅🎀✨