Developer Resources

Class Index By Category

SpinBox

Overview

The SpinBox class represents a spin box control.

Base Class

FormControl

Constructor

SpinBox(x_pos : Integer, y_pos : Integer, width : Integer, height : Integer)

Arguments

x_pos: The x position of the control.
y_pos: The y position of the control.
width: The width of the control.
height: The height of the control.

Events

SpinBox.changed: Fired when the spin button's value is changed.
SpinBox.spinDown: Fired when the menu item is clicked.
SpinBox.spinUp: Fired when the menu item is clicked.

Methods

SpinBox.getMax: Gets the maximum value the spin box can have.
SpinBox.getMin: Gets the minimum value the spin box can have.
SpinBox.getValue: Gets the value of the spin box.
SpinBox.setRange: Sets the minimum and maximum range of the spin box.
SpinBox.setValue: Sets the value of the spin box.

Inherited Methods

FormControl.captureMouse: Captures the mouse on this form control.
FormControl.disablePaint: Disables the window from redrawing itself.
FormControl.enablePaint: Enables the window to redraw itself.
FormControl.getBackgroundColor: Gets the background color of the form control.
FormControl.getClientSize: Gets the client size of the form control.
FormControl.getEnabled: Indicates whether or not a form control is enabled.
FormControl.getFont: Gets the default font for the text of form control.
FormControl.getForegroundColor: Gets the foreground color of the form control.
FormControl.getMaxSize: Gets the maximum size of the form control.
FormControl.getMinSize: Gets the minimum size of the form control.
FormControl.getMousePosition: Gets the mouse position relative to this form control.
FormControl.getNativeHandle: Gets the native handle of the window/control
FormControl.getPosition: Gets the position of a form control.
FormControl.getSize: Gets the size of the form control.
FormControl.invalidate: Invalidates a form control, which will cause it to be repainted on the next paint event.
FormControl.refresh: Refreshes a form control, which immediately repaints the entire form control.
FormControl.releaseMouse: Releases the mouse from being captured on this form control.
FormControl.setBackgroundColor: Sets the background color of the form control.
FormControl.setClientSize: Sets the client size of a form control.
FormControl.setEnabled: Enables or disables the form control.
FormControl.setFocus: Sets the focus to the form control.
FormControl.setFont: Sets the default font for the text of the form control.
FormControl.setForegroundColor: Sets the foreground color of the form control.
FormControl.setMaxSize: Sets the maximum size of a form control.
FormControl.setMinSize: Sets the minimum size of a form control.
FormControl.setPosition: Sets the position of a form control relative to the the form control's parent.
FormControl.setSize: Sets the size of a form control.
FormControl.show: Shows or hides the form control.
FormControl.update: Updates a form control, which will immediately repaint any invalid areas.

SpinBox.getMax

function SpinBox.getMax() : Integer

Returns

Returns the maximum value the spin box can have.

Description

Returns the maximum value the spin box can have.

SpinBox.getMin

function SpinBox.getMin() : Integer

Returns

Returns the minimum value the spin box can have.

Description

Returns the minimum value the spin box can have.

SpinBox.getValue

function SpinBox.getValue() : Integer

Returns

Returns the current value of the spin box.

Description

Returns the current value of the spin box.

SpinBox.setRange

function SpinBox.setRange(minimum : Integer, maximum : Integer)

Arguments

minimum: The minimum value the spin box value can have.
maximum: The maximum value the spin box value can have.

Description

Sets the minimum and maximum range of the spin box, limiting the value the spin box can have to this range.

SpinBox.setValue

function SpinBox.setValue(number : Integer)

Arguments

number: The value to which to set the spin box value.

Description

Sets the value of the spin box to number.