Class WindowUI

Entity UI that represent a window

Implements

Properties

BackgroundRect

Rect position of the background part in global space

Declaration

public virtual IRect BackgroundRect { get; }

DefaultWindowName

Failback display name of this type of window

Declaration

public virtual string DefaultWindowName { get; }

IsDirty

True if the content of the window have unsaved changes

Declaration

public bool IsDirty { get; }

NotificationContent

Content data for the notification this window require to display

Declaration

public string NotificationContent { get; set; }

NotificationSubContent

Secondary content data for the notification this window require to display

Declaration

public string NotificationSubContent { get; set; }

RequiringTooltipContent

Content data for the tooltip this window require to display

Declaration

public string RequiringTooltipContent { get; set; }

RequiringTooltipRect

Rect position in global space for the tooltip this window require to display

Declaration

public IRect RequiringTooltipRect { get; }

Skin

Built-in skin of the system

Declaration

protected GUISkin Skin { get; }

WindowRect

Rect position for the root boundary in global space

Declaration

public static IRect WindowRect { get; }

Methods

CleanDirty()

Mark this window as not dirty (do not contains unsaved changes)

Declaration

public virtual void CleanDirty()

ForceWindowRect(IRect)

Set window rect for all window UI

Declaration

public static void ForceWindowRect(IRect newRect)

RequireNotification(string, string)

Require a notification.

Declaration

protected void RequireNotification(string content, string subContent = null)

RequireTooltip(IRect, string)

Require display tooltip for given range. Call this function every frame no matter the tooltip should be currently display or not.

Declaration

protected void RequireTooltip(IRect rect, string content)

Save(bool)

Require save the data

Declaration

public virtual void Save(bool forceSave = false)

Parameters

Type	Name	Description
bool	forceSave	True if this save performs without dirty checks

SetDirty()

Mark this window as dirty (contains unsaved changes)

Declaration

public virtual void SetDirty()

UpdateUI()

Declaration

public override sealed void UpdateUI()

Overrides

EntityUI.UpdateUI()

UpdateWindowUI()

Declaration

public abstract void UpdateWindowUI()