FirstModulAR 0.1.0
Loading...
Searching...
No Matches
FMAR.UI.Widgets.Tab Class Reference

An individual tab in a tabbed display. More...

Inheritance diagram for FMAR.UI.Widgets.Tab:
FMAR.UI.Widgets.WidgetContainer

Public Member Functions

WidgetContainer Init (TabbedDisplay tabbedDisplay, Widget widget, Vector2 size, bool disableCollidersOverride=false, float scaleFactor=-1, bool disableInitEvent=false)
 Initializes the tab.
 
void SetIcon (Sprite sprite)
 Sets the icon for the tab.
 
- Public Member Functions inherited from FMAR.UI.Widgets.WidgetContainer
virtual WidgetContainer Init (Widget widget, Vector2 size, bool disableCollidersOverride=false, float scaleFactor=-1, bool disableInitEvent=false)
 Initializes the widget container.
 
void UpdateSize (Vector2 size)
 Sets the size of the widget container.
 
virtual void DetachWidget ()
 Detaches the widget from the widget container.
 
void ToggleLockedState ()
 Toggles the locked state of the widget container, which determines if the widget can be removed or added.
 
bool TryMove ()
 Tries to move the widget.
 

Protected Member Functions

override void Awake ()
 
- Protected Member Functions inherited from FMAR.UI.Widgets.WidgetContainer
void CreateBorder ()
 
virtual void Update ()
 

Properties

TabbedDisplay TabbedDisplay [get]
 
- Properties inherited from FMAR.UI.Widgets.WidgetContainer
Widget Widget [get]
 
Vector2 Size [get]
 
float ScaleFactor [get]
 
LineRenderer Border [get]
 
bool HoverLeft [get]
 
bool HoverRight [get]
 
bool Hover [get]
 
bool Locked [get]
 

Additional Inherited Members

- Protected Attributes inherited from FMAR.UI.Widgets.WidgetContainer
Widget widget
 
Vector2 size = Vector2.one
 
Material borderMaterial
 
LineRenderer border
 
bool locked
 
- Events inherited from FMAR.UI.Widgets.WidgetContainer
static Action< WidgetContainerOnInit
 

Detailed Description

An individual tab in a tabbed display.

Member Function Documentation

◆ Awake()

override void FMAR.UI.Widgets.Tab.Awake ( )
inlineprotectedvirtual

Reimplemented from FMAR.UI.Widgets.WidgetContainer.

◆ Init()

WidgetContainer FMAR.UI.Widgets.Tab.Init ( TabbedDisplay tabbedDisplay,
Widget widget,
Vector2 size,
bool disableCollidersOverride = false,
float scaleFactor = -1,
bool disableInitEvent = false )
inline

Initializes the tab.

Parameters
tabbedDisplayThe tabbed display this tab belongs to.
widgetThe widget to place into the tab.
sizeThe size of the tab.
disableCollidersOverrideWhether to disable the colliders.
scaleFactorThe scale factor to use.
disableInitEventWhether to disable the init event.
Returns
This tab, as a WidgetContainer.

◆ SetIcon()

void FMAR.UI.Widgets.Tab.SetIcon ( Sprite sprite)
inline

Sets the icon for the tab.

Parameters
spriteThe sprite to use.

Property Documentation

◆ TabbedDisplay

TabbedDisplay FMAR.UI.Widgets.Tab.TabbedDisplay
get

The documentation for this class was generated from the following file: