SpinBox (hwx.gui)

A SpinBox Widget.

SpinBox allows to choose a value by clicking the up/down buttons or pressing up/down on the keyboard to increase/decrease the displayed value.

The upper and lower bounds are defined by the min and max properties. The user can also type the value manually. The SpinBox supports integer values and invokes the callback command every time the value is changed.



Public Methods

addChildren (self, children)

destroy (self)

enableGlobalActions (self, enable)

getMousePosition (self)

getRelativeMousePosition (self)

hide (self)

saveAsPng (self, fname)

setF1HelpTopic (self, helptopic)

setProperties (self, kwds)

setValue (self, value)

show (self)

Property Details

property max

The maximum integer value.

property min

The minimum integer value.

property prefix

The text that appears before the int.

property step

The value by which SpinBox is increased/decreased when you click the arrows.

property suffix

The text that appears after the int.

Method Details

addChildren(self, children)

Add child widgets/layouts into this widget.

Widget children get layed out using a VBoxLayout.

Typically, you’ll pass the parent/children into the constructor instead of calling this function directly.

param children

type children

list[Widget] | Layout


Deletes this and all its children.

enableGlobalActions(self, enable)

Sets the state of Global Actions.

Disable the global actions to get key events.

param enable

Determines whether to enable or disable global actions.

type enable



Returns the mouse position.


Returns the mouse position relative to this widget.


Hides the widget.

saveAsPng(self, fname)

Saves the widget as a .png file.

param fname

The file name for the .png

type fname



True if it was saved succesfully, False otherwise.



setF1HelpTopic(self, helptopic)

Popup web-browser helps when the user hits F1 when over this.

param helptopic

Topic name user needs help in.

type helptopic


setProperties(self, kwds)

Internal method called from constructors.

setValue(self, value)

Sets the specified value after converting it into an integer.

param value

The numeric value to be set for the SpinBox.

type value



Shows the widget.