Class UIModule

Manages Editor UI. Especially main window UI.

Inheritance

System.Object

FlaxEditor.Modules.EditorModule

UIModule

Namespace: FlaxEditor.Modules

Assembly: FlaxEngine.CSharp.dll

Syntax

public sealed class UIModule : EditorModule

Fields

MainMenu

The main menu control.

Declaration

public MainMenu MainMenu

Field Value

MainMenu

MasterPanel

The master dock panel for all Editor windows.

Declaration

public MasterDockPanel MasterPanel

Field Value

MasterDockPanel

StatusBar

The status strip control.

Declaration

public StatusBar StatusBar

Field Value

StatusBar

ToolStrip

The tool strip control.

Declaration

public ToolStrip ToolStrip

Field Value

ToolStrip

VisjectSurfaceBackground

The visject surface background texture. Cached to be used globally.

Declaration

public Texture VisjectSurfaceBackground

Field Value

Texture

Properties

IsPauseButtonChecked

Checks if toolstrip pause button is being checked.

Declaration

public bool IsPauseButtonChecked { get; }

Property Value

System.Boolean

MenuEdit

Gets the Edit menu.

Declaration

public MainMenuButton MenuEdit { get; }

Property Value

FlaxEditor.GUI.MainMenuButton

MenuFile

Gets the File menu.

Declaration

public MainMenuButton MenuFile { get; }

Property Value

FlaxEditor.GUI.MainMenuButton

MenuGame

Gets the Game menu.

Declaration

public MainMenuButton MenuGame { get; }

Property Value

FlaxEditor.GUI.MainMenuButton

MenuHelp

Gets the Help menu.

Declaration

public MainMenuButton MenuHelp { get; }

Property Value

FlaxEditor.GUI.MainMenuButton

MenuScene

Gets the Scene menu.

Declaration

public MainMenuButton MenuScene { get; }

Property Value

FlaxEditor.GUI.MainMenuButton

MenuTools

Gets the Tools menu.

Declaration

public MainMenuButton MenuTools { get; }

Property Value

FlaxEditor.GUI.MainMenuButton

MenuWindow

Gets the Window menu.

Declaration

public MainMenuButton MenuWindow { get; }

Property Value

FlaxEditor.GUI.MainMenuButton

Methods

AddMenuButton(String, String, Action)

Adds the menu button.

Declaration

public ContextMenuButton AddMenuButton(string group, string text, Action clicked)

Parameters

System.String group The group.

System.String text The text.

System.Action clicked The button clicked event.

Returns

FlaxEditor.GUI.ContextMenu.ContextMenuButton The created menu item.

AddStatusMessage(String)

Adds the status bar message text to be displayed as a notification.

Declaration

public void AddStatusMessage(string message)

Parameters

System.String message The message to display.

OnEndInit()

Declaration

public override void OnEndInit()

Overrides

FlaxEditor.Modules.EditorModule.OnEndInit()

OnExit()

Declaration

public override void OnExit()

Overrides

FlaxEditor.Modules.EditorModule.OnExit()

OnInit()

Declaration

public override void OnInit()

Overrides

FlaxEditor.Modules.EditorModule.OnInit()

OnUpdate()

Declaration

public override void OnUpdate()

Overrides

FlaxEditor.Modules.EditorModule.OnUpdate()

UncheckPauseButton()

Unchecks toolstrip pause button.

Declaration

public void UncheckPauseButton()

UpdateStatusBar()

Updates the status bar.

Declaration

public void UpdateStatusBar()

UpdateToolstrip()

Updates the toolstrip.

Declaration

public void UpdateToolstrip()

Events

MainMenuShortcutKeysUpdated

Fired when the main menu short cut keys are updated. Can be used to update plugin short cut keys.

Declaration

public event Action MainMenuShortcutKeysUpdated

Event Type

System.Action

Extension Methods

Extensions.ReflectiveCompare<T>(T, T)

Extensions.RawClone<T>(T)

See Also

FlaxEditor.Modules.EditorModule