s&box docs
API ReferenceEditor

Menuclass

object→Widget→Menu
Namespace
Editor
Assembly
Sandbox.Tools
Declaration
public class Editor.Menu : Editor.Widget

Constructors2

Showing 2 constructors

Methods31

Showing 31 methods

public Editor.Label AddHeading(string title)PUBLIC

ParameterTypeDescription
titlestring—
Returns:Label—

public virtual Editor.Option AddOptionWithImage(string name, Editor.Pixmap icon, System.Action action = null, string shortcut = null)PUBLICVIRTUAL

ParameterTypeDescription
namestring—
iconPixmap—
action = nullAction—
shortcut = nullstring—
Returns:Option—

public T AddWidget(T widget)PUBLIC

Add a widget as an action to the menu. Some widgets such as `Editor.Widget` and `Editor.LineEdit` require `Editor.Widget.OnMouseReleased(Editor.MouseEvent)` to set `Editor.MouseEvent.Accepted` to to prevent the menu from closing.

ParameterTypeDescription
widgetT—
Returns:T—

public void Clear()PUBLIC

Returns:void—

public Editor.Menu FindOrCreateMenu(string name)PUBLIC

ParameterTypeDescription
namestring—
Returns:Menu—

public Editor.Option GetOption(string name)PUBLIC

ParameterTypeDescription
namestring—
Returns:Option—

protected virtual void OnAboutToHide()PROTECTEDVIRTUAL

Returns:void—

protected virtual void OnAboutToShow()PROTECTEDVIRTUAL

Returns:void—

public void OpenAt(Vector2 position, bool modal = True)PUBLIC

ParameterTypeDescription
positionVector2—
modal = Truebool—
Returns:void—

public void OpenAtCursor(bool modal = False)PUBLIC

Open this menu at the mouse cursor position

ParameterTypeDescription
modal = Falsebool—
Returns:void—

public void RemoveMenus()PUBLIC

Remove all menus

Returns:void—

public void RemoveOptions()PUBLIC

Remove all options

Returns:void—

public void RemoveWidget(Editor.Widget widget)PUBLIC

ParameterTypeDescription
widgetWidget—
Returns:void—

public void RemoveWidgets()PUBLIC

Remove all widgets

Returns:void—

Properties12

Showing 12 properties

public bool Editor.Menu.HasMenus { get; set; }PUBLICGETSET

Returns:bool—

public bool Editor.Menu.HasOptions { get; set; }PUBLICGETSET

Returns:bool—

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

Returns:string—

public int Editor.Menu.OptionCount { get; set; }PUBLICGETSET

Returns:int—

public Editor.Menu Editor.Menu.ParentMenu { get; set; }PUBLICGETSET

Returns:Menu—

public Editor.Menu Editor.Menu.RootMenu { get; set; }PUBLICGETSET

Returns:Menu—

public Editor.Option Editor.Menu.SelectedOption { get; set; }PUBLICGETSET

Returns:Option—

public string Editor.Menu.Title { get; set; }PUBLICGETSET

Returns:string—

public virtual string Editor.Menu.ToolTip { get; set; }PUBLICVIRTUALGETSET

Returns:string—

public bool Editor.Menu.ToolTipsVisible { get; set; }PUBLICGETSET

This property holds whether tooltips of menu actions should be visible. This property specifies whether action menu entries show their tooltip. By default, this property is `false`.

Returns:bool—

public System.Collections.Generic.IReadOnlyList`1<Editor.Widget> Editor.Menu.Widgets { get; set; }PUBLICGETSET

Returns:IReadOnlyList<Widget>—

Related Guides

→ISceneStartup→Localization→Style Properties

OnPaint()

Previous Page

HasMenus

Next Page

On this page

Constructorspublic Menu(Editor.Widget parent = null)public Menu(System.String title, Editor.Widget parent = null)Methodspublic Editor.Label AddHeading(System.String title)public Editor.Menu AddMenu(Editor.Menu menu)public Editor.Menu AddMenu(System.String name, System.String icon = null)public virtual Editor.Option AddOption(Editor.Option option)public Editor.Option AddOption(System.ReadOnlySpan`1<Editor.Menu.PathElement> path, System.Action action = null, System.String shortcut = null)public virtual Editor.Option AddOption(System.String name, System.String icon = null, System.Action action = null, System.String shortcut = null)public Editor.Option AddOption(System.String[] path, System.String icon = null, System.Action action = null, System.String shortcut = null)public System.Void AddOptions(System.Collections.Generic.IEnumerable`1<T> items, System.Action`1<T> action = null, System.Boolean flat = False, System.Boolean reduce = True, System.String defaultSubMenuIcon = folder)public System.Void AddOptions(System.Collections.Generic.IEnumerable`1<T> items, System.Func`2<T,Editor.Menu.PathElement[]> getPath, Editor.Menu.CreateOptionDelegate`1<T> createOption, System.Boolean flat = False, System.Boolean reduce = True, System.String defaultSubMenuIcon = folder)public System.Void AddOptions(System.Collections.Generic.IEnumerable`1<T> items, System.Func`2<T,Editor.Menu.PathElement[]> getPath, System.Action`1<T> action = null, System.Boolean flat = False, System.Boolean reduce = True, System.String defaultSubMenuIcon = folder)public System.Void AddOptions(System.Collections.Generic.IEnumerable`1<T> items, System.Func`2<T,System.String> getPath, System.Action`1<T> action = null, System.Boolean flat = False, System.Boolean reduce = True, System.String defaultSubMenuIcon = folder)public virtual Editor.Option AddOptionWithImage(System.String name, Editor.Pixmap icon, System.Action action = null, System.String shortcut = null)public Editor.Option AddSeparator()public T AddWidget(T widget)public System.Void Clear()public Editor.Menu FindOrCreateMenu(System.String name)public Editor.Option GetOption(System.String name)public System.Void GetPathTo(System.ReadOnlySpan`1<Editor.Menu.PathElement> path, System.Collections.Generic.List`1<Editor.Menu> list)public System.Void GetPathTo(System.String path, System.Collections.Generic.List`1<Editor.Menu> list)public static Editor.Menu.PathElement[] GetSplitPath(Sandbox.Internal.ITitleProvider item)public static Editor.Menu.PathElement[] GetSplitPath(System.String path)protected virtual System.Void OnAboutToHide()protected virtual System.Void OnAboutToShow()public System.Void OpenAt(Vector2 position, System.Boolean modal = True)public System.Void OpenAtCursor(System.Boolean modal = False)public System.Void RemoveMenus()public System.Void RemoveOption(Editor.Option option)public System.Void RemoveOption(System.String name)public System.Void RemoveOptions()public System.Void RemoveWidget(Editor.Widget widget)public System.Void RemoveWidgets()Propertiespublic System.Boolean Editor.Menu.HasMenus { get; set; }public System.Boolean Editor.Menu.HasOptions { get; set; }public System.String Editor.Menu.Icon { get; set; }public System.Int32 Editor.Menu.MenuCount { get; set; }public System.Int32 Editor.Menu.OptionCount { get; set; }public Editor.Menu Editor.Menu.ParentMenu { get; set; }public Editor.Menu Editor.Menu.RootMenu { get; set; }public Editor.Option Editor.Menu.SelectedOption { get; set; }public System.String Editor.Menu.Title { get; set; }public virtual System.String Editor.Menu.ToolTip { get; set; }public System.Boolean Editor.Menu.ToolTipsVisible { get; set; }public System.Collections.Generic.IReadOnlyList`1<Editor.Widget> Editor.Menu.Widgets { get; set; }Metadata