SCR_WidgetHelper Interface Reference

Static Public Member Functions
static void	GetAllChildren (notnull Widget widget, notnull out array< ref Widget > widgetArray, bool recursive=false)
	Return a widget's children.
static void	RemoveAllChildren (notnull Widget widget)
	Remove all child widgets from the provided widget.
static void	ResizeToImage (notnull ImageWidget widget, int imageIndex=0)
static Widget	GetRootWidget (notnull Widget widget)
	Return the root widget (before the WorkspaceWidget)
static Widget	GetWidgetOrChild (notnull Widget widget, string widgetName)
	Get widget or one of its children that has the provided (case-sensitive) name.

Member Function Documentation

GetAllChildren()

static void SCR_WidgetHelper.GetAllChildren ( notnull Widget widget, notnull out array< ref Widget > widgetArray, bool recursive = false )

static

Return a widget's children.

The search is not recursive by default.

Parameters

[in]	widget
[in]	widgetArray	this array is NOT cleared, only appended
[in]	recursive	set to true to obtain sub-children as well

GetRootWidget()

static Widget SCR_WidgetHelper.GetRootWidget ( notnull Widget widget )

static

Return the root widget (before the WorkspaceWidget)

Parameters

[in]

Widget

Returns

the "topmost" parent (in hierarchy notion, not in z-index notion)

GetWidgetOrChild()

static Widget SCR_WidgetHelper.GetWidgetOrChild ( notnull Widget widget, string widgetName )

static

Get widget or one of its children that has the provided (case-sensitive) name.

Parameters

[in]	widget
[in]	widgetName	case-sensitive

Returns

the provided widget (if the name matches) or one of its children (if the name matches) or null if not found

RemoveAllChildren()

static void SCR_WidgetHelper.RemoveAllChildren ( notnull Widget widget )

static

Remove all child widgets from the provided widget.

Parameters

[in]

widget

ResizeToImage()

static void SCR_WidgetHelper.ResizeToImage ( notnull ImageWidget widget, int imageIndex = 0 )

static

Parameters

[in]	widget
[in]	imageIndex

---

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

• Game/Helpers/SCR_WidgetHelper.c