s&box docs
API ReferenceEditor

DropdownControlWidgetclass

Base class for dropdown control widgets with multi-select support.

object→ControlWidget→DropdownControlWidget
Namespace
Editor
Assembly
Sandbox.Tools
Declaration
public abstract class Editor.DropdownControlWidget : Editor.ControlWidget

Constructors1

Showing 1 constructors

Methods7

Showing 7 methods

protected Editor.Widget AddMenuOption(Editor.Widget canvas, string displayName, string icon, System.Func`1<bool> isSelected, System.Action onSelect)PROTECTED

ParameterTypeDescription
canvasWidget—
displayNamestring—
iconstring—
isSelectedFunc<bool>—
onSelectAction—
Returns:Widget—

protected virtual void OnDoubleClick(Editor.MouseEvent e)PROTECTEDVIRTUAL

ParameterTypeDescription
eMouseEvent—
Returns:void—

protected virtual void OnMouseClick(Editor.MouseEvent e)PROTECTEDVIRTUAL

ParameterTypeDescription
eMouseEvent—
Returns:void—

protected virtual void PaintControl()PROTECTEDVIRTUAL

Returns:void—

protected virtual void PaintDisplayText(Sandbox.Rect rect, Color color)PROTECTEDVIRTUAL

Override to paint the display text in the control

ParameterTypeDescription
rectRect—
colorColor—
Returns:void—

protected virtual void PopulateMenu(Editor.Widget canvas)PROTECTEDVIRTUAL

Override to populate the menu with options

ParameterTypeDescription
canvasWidget—
Returns:void—

public virtual void StartEditing()PUBLICVIRTUAL

Returns:void—

Properties4

Showing 4 properties

public virtual bool Editor.DropdownControlWidget.IsControlActive { get; set; }PUBLICVIRTUALGETSET

Returns:bool—

public virtual bool Editor.DropdownControlWidget.IsControlButton { get; set; }PUBLICVIRTUALGETSET

Returns:bool—

public virtual bool Editor.DropdownControlWidget.IsControlHovered { get; set; }PUBLICVIRTUALGETSET

Returns:bool—

DropAction

Previous Page

IsControlActive

Next Page

On this page

Constructorspublic DropdownControlWidget(Sandbox.SerializedProperty property)Methodsprotected Editor.Widget AddMenuOption(Editor.Widget canvas, System.String displayName, System.String icon, System.Func`1<System.Boolean> isSelected, System.Action onSelect)protected virtual System.Void OnDoubleClick(Editor.MouseEvent e)protected virtual System.Void OnMouseClick(Editor.MouseEvent e)protected virtual System.Void PaintControl()protected virtual System.Void PaintDisplayText(Sandbox.Rect rect, Color color)protected virtual System.Void PopulateMenu(Editor.Widget canvas)public virtual System.Void StartEditing()Propertiespublic virtual System.Boolean Editor.DropdownControlWidget.IsControlActive { get; set; }public virtual System.Boolean Editor.DropdownControlWidget.IsControlButton { get; set; }public virtual System.Boolean Editor.DropdownControlWidget.IsControlHovered { get; set; }protected System.Boolean Editor.DropdownControlWidget.IsMultiSelect { get; set; }Metadata