Class WindowDecorations

Represents the title bar of the window with buttons.

System.Object
Control
ContainerControl
WindowDecorations
System.IComparable
Namespace: FlaxEditor.GUI
Assembly: FlaxEngine.CSharp.dll
Syntax
public class WindowDecorations : ContainerControl, IComparable, IDrawable

Constructors

WindowDecorations(RootControl, Boolean)

Initializes a new instance of the WindowDecorations class.

Declaration
public WindowDecorations(RootControl window, bool iconOnly = false)
Parameters
RootControl window

The window.
System.Boolean iconOnly

When set, omit drawing title and buttons.

Properties

Icon

The icon used in the title bar.

Declaration
public Image Icon { get; }
Property Value
Image

IconTooltipText

The tooltip shown when hovering over the icon.

Declaration
public string IconTooltipText { get; set; }
Property Value
System.String

Title

The title label in the title bar.

Declaration
public Label Title { get; }
Property Value
Label

Methods

Draw()

Draw the control and the children.

Declaration
public override void Draw()
Overrides

DrawBorders()

Draw borders around the window.

Declaration
public virtual void DrawBorders()

OnDestroy()

Method called when managed instance should be destroyed

Declaration
public override void OnDestroy()
Overrides

OnHitTest(ref Float2)

Perform hit test on the window.

Declaration
protected virtual WindowHitCodes OnHitTest(ref Float2 mouse)
Parameters
Float2 mouse

The mouse position
Returns
WindowHitCodes

The hit code for given position.

OnMouseDoubleClick(Float2, MouseButton)

When mouse double clicks over control's area

Declaration
public override bool OnMouseDoubleClick(Float2 location, MouseButton button)
Parameters
Float2 location

Mouse location in Control Space
MouseButton button

Mouse buttons state (flags)
Returns
System.Boolean

True if event has been handled, otherwise false
Overrides

PerformLayoutAfterChildren()

Perform layout for that container control after performing it for child controls.

Declaration
protected override void PerformLayoutAfterChildren()
Overrides

Update(Single)

Perform control update and all its children

Declaration
public override void Update(float deltaTime)
Parameters
System.Single deltaTime

Delta time in seconds
Overrides

Extension Methods

See Also