wxSpinCtrl(3)

💖 wxSpinCtrl 💖

okay so bestie, welcome to the wxSpinCtrl(3) manual page, and yes it's the Erlang Module Definition version. wxSpinCtrl is that iconic combo control: it combines wxTextCtrl and wxSpinButton in one control. one control, two vibes, zero need to pick a favorite. 🎀

✨ NAME ✨

wxSpinCtrl — combines wxTextCtrl and wxSpinButton in one control. periodt.

🦋 DESCRIPTION 🦋

🎨 Styles 🎨

This class supports the following styles, and you're gonna wanna know them all, fr fr:

• wxSP_ARROW_KEYS — the user can use arrow keys to change the value. keyboard main character energy.
• wxSP_WRAP — the value wraps at the minimum and maximum. it's giving circular.
• wxTE_PROCESS_ENTER — indicates that the control should generate wxEVT_TEXT_ENTER events. Using this style will prevent the user from using the Enter key for dialog navigation (e.g. activating the default button in the dialog) under MSW. so yes, it can lowkey steal your Enter key on MSW; that's the tradeoff.
• wxALIGN_LEFT — same as wxTE_LEFT for wxTextCtrl: the text is left aligned (this is the default). left-aligned default, as expected.
• wxALIGN_CENTRE_HORIZONTAL — same as wxTE_CENTRE for wxTextCtrl: the text is centered. centered slay.
• wxALIGN_RIGHT — same as wxTE_RIGHT for wxTextCtrl: the text is right aligned. right-aligned, no further notes.

See:

• wxSpinButton
• wxControl

This class is derived, and can use functions, from:

• wxControl
• wxWindow
• wxEvtHandler

wxWidgets docs: wxSpinCtrl — that's where the official docs live.

🎉 Events 🎉

Event types emitted from this class:

• command_spinctrl_updated

🧸 DATA TYPES 🧸

wxSpinCtrl() :: wx:wx_object().

👑 FUNCTIONS 👑

🌟 create/3 🌟

create(This, Parent, [Option]) -> boolean()
                when
                    This :: wxSpinCtrl(),
                    Parent :: wxWindow:wxWindow(),
                    Option ::
                        {id, integer()} |
                        {value, unicode:chardata()} |
                        {pos, {X :: integer(), Y :: integer()}} |
                        {size, {W :: integer(), H :: integer()}} |
                        {style, integer()} |
                        {min, integer()} |
                        {max, integer()} |
                        {initial, integer()}.

Creation function called by the spin control constructor.

See new/2 for details.

🧼 destroy/1 🧼

destroy(This :: wxSpinCtrl()) -> ok.

Destroys the object. bye bye, bestie. 💅

📈 getMax/1 📈

getMax(This) -> integer() when This :: wxSpinCtrl().

Gets maximal allowable value.

📉 getMin/1 📉

getMin(This) -> integer() when This :: wxSpinCtrl().

Gets minimal allowable value.

🔢 getValue/1 🔢

getValue(This) -> integer() when This :: wxSpinCtrl().

Gets the value of the spin control.

🐣 new/0 🐣

new() -> wxSpinCtrl().

Default constructor. baby spin control, no parent yet.

🌸 new/2 🌸

new(Parent, [Option]) -> wxSpinCtrl()
                when
                    Parent :: wxWindow:wxWindow(),
                    Option ::
                        {id, integer()} |
                        {value, unicode:chardata()} |
                        {pos, {X :: integer(), Y :: integer()}} |
                        {size, {W :: integer(), H :: integer()}} |
                        {style, integer()} |
                        {min, integer()} |
                        {max, integer()} |
                        {initial, integer()}.

Constructor, creating and showing a spin control.

If value is non-empty, it will be shown in the text entry part of the control and if it has numeric value, the initial numeric value of the control, as returned by getValue/1 will also be determined by it instead of by initial. Hence, it only makes sense to specify initial if value is an empty string or is not convertible to a number, otherwise initial is simply ignored and the number specified by value is used.

See: create/3

🚦 setRange/3 🚦

setRange(This, MinVal, MaxVal) -> ok
                    when
                        This :: wxSpinCtrl(),
                        MinVal :: integer(),
                        MaxVal :: integer().

Sets range of allowable values.

Notice that calling this method may change the value of the control if it's not inside the new valid range, e.g. it will become minVal if it is less than it now. However no wxEVT_SPINCTRL event is generated, even if the value does change.

Note: Setting a range including negative values is silently ignored if current base is set to 16.

✂️ setSelection/3 ✂️

setSelection(This, From, To) -> ok
                        when
                            This :: wxSpinCtrl(),
                            From :: integer(),
                            To :: integer().

Select the text in the text part of the control between positions from (inclusive) and to (exclusive).

This is similar to wxTextCtrl:setSelection/3.

Note: this is currently only implemented for Windows and generic versions of the control.

🎚️ setValue/2 🎚️

setValue(This, Value) -> ok
                    when This :: wxSpinCtrl(), Value :: integer();
                (This, Text) -> ok
                    when This :: wxSpinCtrl(), Text :: unicode:chardata().

Sets the value of the spin control.

It is recommended to use the overload taking an integer value instead.

Notice that, unlike wxTextCtrl:setValue/2, but like most of the other setter methods in wxWidgets, calling this method does not generate any events as events are only generated for the user actions.

---

that's the whole page, bestie. no cap, every style, function, note, and reference is here. 💖

cute sign-off: brought to you by Ericsson AB, wx 2.6, and the wxSpinCtrl(3) manual page. the footer doesn't give a separate date, so we're not inventing one — just sending love from the version that says wx 2.6. 🫶✨