IWidgetGuiConsumer

Description

interface Tinman.Engine.Widgets.IWidgetGuiConsumer

Extended by

IWidget

Base interface for classes that consume WidgetGui values.

Public / Methods

Widget​Gui​Attach

public method WidgetGuiAttach → (1)

widgetGui in : IWidgetGui

[not-null]
The WidgetGui instance.

Attaches this object to the given WidgetGui instance.

As best practice, implementing classes should create their user interface components in this method and call IWidgetGui.PanelAdd accordingly.

The calls to WidgetGuiAttach resp. WidgetGuiDetach may be omitted, for example when running without a widget GUI overlay. Implementing classes must take this into account and should not rely on the premise that this method is always called.

Widget​Gui​Detach

public method WidgetGuiDetach → ()

Detaches this object from its WidgetGui instance.

Implementing classes must remove all panels via IWidgetGui.PanelRemove that they have added to the widget GUI.