WsCheckbox:
Filter:
WsGUI/Classes (extension) | GUI > WsGUI | Extensions

WsCheckbox
ExtensionExtension

A WsGUI checkbox widget.

Description

This widget displays a checkbox that can be checked/unchecked.

Class Methods

.new

Create new instance and add it to the window immediately.

.init

Create new instance without adding it to the window. Use this when using WsLayout.

Arguments:

wsWindow

An instance of WsWindow

bounds

A Rect specifying the size of the widget.

NOTE: Currently a relative measurement is used: 1 for full window width, 1 for full window height, e.g. Rect(0, 0, 1, 1) would occupy whole window.

Returns:

an instance of the widget

Instance Methods

.action

Gets or sets function to be evaluated when the button is pressed. Function is passed the number of the current state number.

Arguments:

function

Any object to set as default action, usually a Function. It is passed the current instance.

.value

Sets the current state. Does not trigger the action.

Arguments:

val

An integer setting the state number (0/1).

.valueAction

Sets the current state and triggers the action.

Arguments:

val

An integer setting the state number (0/1).

Examples