XMSIMPLESPINBOX(3)

hey bestie — welcome to the manual page for XmSimpleSpinBox, aka XmSimpleSpinBox(library call). This is part 1 of 2, so buckle up. 💖

✨ NAME ✨

XmSimpleSpinBox — a simple SpinBox widget class

🦋 SYNOPSIS 🦋

#include <Xm/SSpinB.h>

💅 DESCRIPTION 💅

The XmSimpleSpinBox widget is a user interface control that increments and decrements an arbitrary TextField. Like, imagine cycling through the months of the year or days of the month. It's giving "spin me right round" energy. ✨

Widget subclassing is not supported for the XmSimpleSpinBox widget class. No cap, bestie.

👑 Classes 👑

The XmSimpleSpinBox widget inherits behavior and resources from the Core, Composite and XmManager classes.

The class pointer is XmSimpleSpinBoxWidgetClass.

The class name is XmSimpleSpinBoxWidget.

🎀 New Resources 🎀

The following resource set defines a set of widget resources used by the application to specify data. The application 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, the application must 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, the application must remove the Xm prefix and use the remaining letters (in either lower case or upper case, but including 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).

🌈 XmSimpleSpinBox Resource Set 🌈

• XmNarrowLayout — Class: XmCArrowLayout · Type: unsigned char · Default: XmARROWS_END · Access: CSG
• XmNarrowSensitivity — Class: XmCArrowSensitivity · Type: unsigned char · Default: XmARROWS-_SENSITIVE · Access: CSG
• XmNcolumns — Class: XmCColumn · Type: short · Default: 20 · Access: CSG
• XmNdecimalPoints — Class: XmCDecimalPoints · Type: short · Default: 0 · Access: CSG
• XmNeditable — Class: XmCEditable · Type: Boolean · Default: True · Access: CSG
• XmNincrementValue — Class: XmCIncrementValue · Type: int · Default: 1 · Access: CSG
• XmNinitialDelay — Class: XmCInitialDelay · Type: unsigned int · Default: 250 · Access: CSG
• XmNmaximumValue — Class: XmCMaximumValue · Type: int · Default: 10 · Access: CSG
• XmNminimumValue — Class: XmCMinimumValue · Type: int · Default: 0 · Access: CSG
• XmNmodifyVerifyCallback — Class: XmCCallback · Type: XtCallbackList · Default: NULL · Access: C
• XmNnumValues — Class: XmCNumValues · Type: int · Default: 0 · Access: CSG
• XmNposition — Class: XmCPosition · Type: int · Default: 0 · Access: CSG
• XmNrepeatDelay — Class: XmCRepeatDelay · Type: unsigned int · Default: 200 · Access: CSG
• XmNspinBoxChildType — Class: XmCSpinBoxChildType · Type: unsigned char · Default: XmSTRING · Access: CG
• XmNtextField — Class: XmCTextField · Type: Widget · Default: dynamic · Access: G
• XmNvalueChangedCallback — Class: XmCCallback · Type: XtCallbackList · Default: NULL · Access: C
• XmNvalues — Class: XmCValues · Type: XmStringTable · Default: NULL · Access: CSG

💖 Resource Deets 💖

• XmNarrowLayout — Specifies the style and position of the SpinBox arrows. The following values are supported:
  • XmARROWS_FLAT_BEGINNING — The arrows are placed side by side to the right of the TextField.
  • XmARROWS_FLAT_END — The arrows are placed side by side to the left of the TextField.
  • XmARROWS_SPLIT — The down arrow is on the left and the up arrow is on the right of the TextField.
  • XmARROWS_BEGINNING — The arrows are stacked and placed on the left of the TextField.
  • XmARROWS_END — The arrows are stacked and placed on the right of the TextField.
• XmNarrowSensitivity — Specifies the sensitivity of the arrows in the XmSimpleSpinBox. The following values are supported:
  • XmARROWS_SENSITIVE — Both arrows are active to user selection.
  • XmARROWS_DECREMENT_SENSITIVE — The down arrow is active and the up arrow is inactive to user selection.
  • XmARROWS_INCREMENT_SENSITIVE — The up arrow is active and the down arrow is inactive to user selection.
  • XmARROWS_INSENSITIVE — Both arrows are inactive to user selection.
• XmNcolumns — Specifies the number of columns of the text field.
• XmNdecimalPoints — Specifies the position of the radix character within the numeric value when XmNspinBoxChildType is XmNUMERIC. This resource is used to allow for floating point values in the XmSimpleSpinBox widget.
• XmNeditable — Specifies whether the text field can take input.

When XmNeditable is used on a widget it sets the dropsite to XmDROP_SITE_ACTIVE.

• XmNincrementValue — Specifies the amount to increment or decrement the XmNposition when the XmNspinBoxChildType is XmNUMERIC. When the Up action is activated, the XmNincrementValue is added to the XmNposition value; when the Down action is activated, the XmNincrementValue is subtracted from the XmNposition value. When XmNspinBoxChildType is XmSTRING, this resource is ignored.
• XmNinitialDelay — Specifies the amount of time in milliseconds before the Arrow buttons will begin to spin continuously.
• XmNnumValues — Specifies the number of items in the XmNvalues list when the XmNspinBoxChildType resource is XmSTRING. The value of this resource must be a positive integer. The XmNnumValues is maintained by the XmSimpleSpinBox widget when items are added or deleted from the XmNvalues list. When XmNspinBoxChildType is not XmSTRING, this resource is ignored.
• XmNvalues — Supplies the list of strings to cycle through when the XmNspinButtonChildType resource is XmSTRING. When XmNspinBoxChildType is not XmSTRING, this resource is ignored.
• XmNmaximumValue — Specifies the upper bound on the XmSimpleSpinBox's range when XmNspinBoxChildType is XmNUMERIC.
• XmNminimumValue — Specifies the lower bound on the XmSimpleSpinBox's range when XmNspinBoxChildType is XmNUMERIC.
• XmNmodifyVerifyCallback — Specifies the callback to be invoked just before the XmSimpleSpinBox position changes. The application can use this callback to implement new application-related logic (including setting new position spinning to, or canceling the impending action). For example, this callback can be used to stop the spinning just before wrapping at the upper and lower position boundaries. If the application sets the doit member of the XmSimpleSpinBoxCallbackStruct to False, nothing happens. Otherwise, the position changes. Reasons sent by the callback are XmCR_SPIN_NEXT, or XmCR_SPIN_PRIOR.
• XmNposition — The XmNposition resource has a different value based on the XmNspinBoxChildType resource. When XmNspinBoxChildType is XmSTRING, the XmNposition is the index into the XmNvalues list for the current item. When the XmNspinBoxChildType resource is XmNUMERIC, the XmNposition is the integer value of the XmSimpleSpinBox that falls within the range of XmNmaximumValue and XmNminimumValue.
• XmNrepeatDelay — Specifies the number of milliseconds between repeated calls to the XmNvalueChangedCallback while the user is spinning the XmSimpleSpinBox.
• XmNspinBoxChildType — Specifies the style of the XmSimpleSpinBox. The following values are supported:
  • XmSTRING — The child is a string value that is specified through the XmNvalues resource and incremented and decremented by changing the XmNposition resource.
  • XmNUMERIC — The child is a numeric value that is specified through the XmNposition resource and incremented according to the XmNincrementValue resource.
• XmtextField — Specifies the textfield widget.
• XmNvalueChangedCallback — Specifies the callback to be invoked whenever the value of the XmNposition resource is changed through the use of the spinner arrows. The XmNvalueChangedCallback passes the XmSimpleSpinBoxCallbackStruct call_data structure.

💫 Inherited Resources 💫

okay so XmSimpleSpinBox doesn't just spawn out of nowhere — it inherits behavior and resources from these named superclasses. for the full tea on each resource, go read the man page for that superclass. periodt. 💅

🌸 XmManager Resource Set 🌸

• XmNbottomShadowColor — class XmCBottomShadowColor, type Pixel, default dynamic, access CSG
• XmNbottomShadowPixmap — class XmCBottomShadowPixmap, type Pixmap, default XmUNSPECIFIED_PIXMAP, access CSG
• 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
• XmNhighlightPixmap — class XmCHighlightPixmap, type Pixmap, default dynamic, access CSG
• XmNinitialFocus — class XmCInitialFocus, type Widget, default NULL, access CSG
• XmNnavigationType — class XmCNavigationType, type XmNavigationType, default dynamic, access CSG
• XmNshadowThickness — class XmCShadowThickness, type Dimension, default dynamic, access CSG
• XmNstringDirection — class XmCStringDirection, type XmStringDirection, default dynamic, access CG
• XmNtopShadowColor — class XmCTopShadowColor, type Pixel, default dynamic, access CSG
• XmNtopShadowPixmap — class XmCTopShadowPixmap, type Pixmap, default dynamic, access CSG
• XmNtraversalOn — class XmCTraversalOn, type Boolean, default dynamic, access CSG
• XmNunitType — class XmCUnitType, type unsigned char, default dynamic, access CSG
• XmNuserData — class XmCUserData, type XtPointer, default NULL, access CSG

🦋 Composite Resource Set 🦋

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

⭐ Core Resource Set ⭐

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

a pointer to this struct gets passed to every XmSimpleSpinBox callback. bestie, look at it:

typedef struct {
        int             reason;
        XEvent          *event;
        Widget          widget;
        Boolean         doit;
        int             position;
        XmString        value;
        Boolean         crossed_boundary;
} XmSimpleSpinBoxCallbackStruct;

the reason arg tells u why the callback got invoked. there are three possible reasons for this callback to be issued. the reason is XmCR_OK when this is the first call to the callback at the beginning of a spin, or if it's a single activation of the spin arrows. if the XmSimpleSpinBox is in the process of being continuously spun, then the reason will be XmCR_SPIN_NEXT or XmCR_SPIN_PRIOR, depending on which arrow is spinning. slay. ✨

the event arg points to the XEvent that triggered the callback. it can be NULL when the XmSimpleSpinBox is continuously spinning. no event, no drama.

the widget arg is the widget identifier for the simple spin box widget that has been affected by this callback. that's the main character right there. 👑

the doit arg is set only when the call_data comes from the XmNmodifyVerifyCallback. it indicates that the action that caused the callback to be called should be performed. the action is not performed if doit is set to False. so if u want it to happen, let doit cook. if not, shut it down. 💅

the position arg is the new value of the XmNposition resource as a result of the spin. it's giving coordinates, but make it spinbox.

the value arg is the new XmString value displayed in the Text widget as a result of the spin. the application must copy this string if it is used beyond the scope of the call_data structure. do not just hold onto it, bestie — copy it fr fr. 😭

the crossed_boundary arg is True when the spinbox cycles. this is the case when a XmNspinBoxChildType of XmSTRING wraps from the first item to the last, or the last item to the first. in the case of the XmNspinBoxChildType of XmNUMERIC, the boundary is crossed when the XmSimpleSpinBox cycles from the maximum value to the minimum or vice versa. it's giving full circle moment. 🌈

---

🚨 ERRORS/WARNINGS 🚨

the toolkit will display a warning if the application tries to set the value of the XmNtextField resource, which is read-only (marked G in the resource table). so like… don't. it's not giving. 💀

---

👀 SEE ALSO 👀

• XmSpinBox(3)
• XmCreateSimpleSpinBox(3)
• XmCreateSpinBox(3)
• XmSimpleSpinBoxAddItem(3)
• XmSimpleSpinBoxDeletePos(3)
• XmSimpleSpinBoxSetItem(3)
• Composite(3)
• Core(3)
• XmManager(3)
• XmText(3)
• XmTextField(3)
• XtGetValues(3)
• XtSetValues(3)
• XmVaCreateSimpleSpinBox(3)
• XmVaCreateManagedSimpleSpinBox(3)

---

and that's the whole page, bestie. this iconic manual is from the XmSimpleSpinBox(library call) source/version — no date shown in the original, but it's still timeless. catch u later, stay slay, and may ur spinboxes never cross a boundary unless u want them to. 💖✨🎀🦋🌸💅