Checkboxclass

A generic checkbox widget.

objectWidgetCheckbox
Namespace
Editor
Assembly
Sandbox.Tools
Declaration
public class Editor.Checkbox : Editor.Widget

Constructors3

Showing 3 constructors

Methods5

Showing 5 methods

protected virtual void OnClicked()PROTECTEDVIRTUAL

Called when checkbox was clicked, on release.

Returns:void

protected virtual void OnPressed()PROTECTEDVIRTUAL

Called when checkbox was pressed down.

Returns:void

protected virtual void OnReleased()PROTECTEDVIRTUAL

Called when checkbox was released.

Returns:void

protected virtual void OnStateChanged(Editor.CheckState state)PROTECTEDVIRTUAL

Called when the `Editor.Checkbox.State` of the checkbox states.

ParameterTypeDescription
stateCheckState
Returns:void

protected virtual void OnToggled()PROTECTEDVIRTUAL

Called when checkbox gets toggled on or off.

Returns:void

Properties5

Showing 5 properties

public string Editor.Checkbox.Icon { get; set; }PUBLICGETSET

Name of a material icon to be drawn in front of the checkbox label.

Returns:string

public string Editor.Checkbox.Text { get; set; }PUBLICGETSET

The checkbox label.

Returns:string

public bool Editor.Checkbox.TriState { get; set; }PUBLICGETSET

Enable the third state, the half checked half not checked state. Disabled by default

Returns:bool

public bool Editor.Checkbox.Value { get; set; }PUBLICGETSET

Whether the checkbox is checked or not.

Returns:bool

On this page