MenuRootComponent Class Reference

Inheritance diagram for MenuRootComponent:

Protected Member Functions
MenuRootBase	GetMenu ()
Widget	GetWidget ()
void	AddComponent (MenuRootSubComponent component)
void	RemoveComponent (MenuRootSubComponent component)
MenuRootSubComponent	FindComponent (typename type, bool showError=false)
int	FindComponents (typename type, notnull out array< MenuRootSubComponent > outComponents)
void	Init (MenuRootBase menu)
void	InitNotRoot ()
void	ExecInit (Widget w)
override void	HandlerAttached (Widget w)

Static Protected Member Functions
static MenuRootComponent	GetRootOf (Widget widget)
static MenuRootComponent	GetRootOf (MenuBase menu)

Protected Attributes
Widget	m_Widget
MenuRootBase	m_Menu
ref array< MenuRootSubComponent >	m_aComponents = {}

Detailed Description

Widget component which can tap to MenuRootBase events. Doesn't need to be added manually, will be created the first time GetComponent() function is called. Subcomponents (MenuRootSubComponent) can access menu and its handlers through this root.

Definition at line 6 of file MenuRootComponent.c.

Member Function Documentation

AddComponent()

void MenuRootComponent::AddComponent ( MenuRootSubComponent component )

inlineprotected

Register subcomponent to this root component.

Parameters

component

Subcomponent

Definition at line 79 of file MenuRootComponent.c.

ExecInit()

void MenuRootComponent::ExecInit ( Widget w )

inlineprotected

Definition at line 162 of file MenuRootComponent.c.

FindComponent()

MenuRootSubComponent MenuRootComponent::FindComponent ( typename type , bool showError = false )

inlineprotected

Find first subcomponent of given type.

Parameters

type	Subcomponent type

Returns

Subcomponent

Definition at line 101 of file MenuRootComponent.c.

FindComponents()

int MenuRootComponent::FindComponents ( typename type , notnull out array< MenuRootSubComponent > outComponents )

inlineprotected

Find all subcomponents of given type

Parameters

	type	Subcomponent type
[out]	outCOmponents	Array to be filled with all compatible subcomponents

Returns

Number of matching subcomponents

Definition at line 122 of file MenuRootComponent.c.

GetMenu()

MenuRootBase MenuRootComponent::GetMenu ( )

inlineprotected

Get the menu instance.

Returns

Menu

Definition at line 59 of file MenuRootComponent.c.

GetRootOf() [1/2]

MenuRootComponent MenuRootComponent::GetRootOf ( MenuBase menu )

inlinestaticprotected

Get the component.

Parameters

menu	Menu of which the root widget is used

Returns

Root component on which events can be invoked.

Definition at line 48 of file MenuRootComponent.c.

GetRootOf() [2/2]

MenuRootComponent MenuRootComponent::GetRootOf ( Widget widget )

inlinestaticprotected

Get the component.

Parameters

widget

Widget of which the root widget is used

Returns

Root component to which events can be attached

Definition at line 18 of file MenuRootComponent.c.

GetWidget()

Widget MenuRootComponent::GetWidget ( )

inlineprotected

Get widget to which the component belongs to.

Returns

Widget

Definition at line 69 of file MenuRootComponent.c.

HandlerAttached()

override void MenuRootComponent::HandlerAttached ( Widget w )

inlineprotected

Definition at line 183 of file MenuRootComponent.c.

Init()

void MenuRootComponent::Init ( MenuRootBase menu )

inlineprotected

Definition at line 134 of file MenuRootComponent.c.

InitNotRoot()

void MenuRootComponent::InitNotRoot ( )

inlineprotected

Definition at line 156 of file MenuRootComponent.c.

RemoveComponent()

void MenuRootComponent::RemoveComponent ( MenuRootSubComponent component )

inlineprotected

Unregister subcomponent from this root component.

Parameters

component

Subcomponent

Definition at line 90 of file MenuRootComponent.c.

Member Data Documentation

m_aComponents

ref array<MenuRootSubComponent> MenuRootComponent::m_aComponents = {}

protected

Definition at line 10 of file MenuRootComponent.c.

m_Menu

MenuRootBase MenuRootComponent::m_Menu

protected

Definition at line 9 of file MenuRootComponent.c.

m_Widget

Widget MenuRootComponent::m_Widget

protected

Definition at line 8 of file MenuRootComponent.c.

---

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

• scripts/Game/UI/Components/MenuRootComponent.c