SCR_SuperMenuComponent Class Reference

Inheritance diagram for SCR_SuperMenuComponent:

Protected Member Functions
void	Init (Widget menuRoot)
void	OnMenuShow ()
void	OnMenuHide ()
void	OnMenuUpdate (float tDelta)
void	OnMenuFocusGained ()
void	OnMenuFocusLost ()
void	OnMenuClose ()
SCR_SubMenuBase	OnTabCreate (SCR_TabViewComponent comp, Widget w, int index)
SCR_SubMenuBase	OnTabShow (SCR_TabViewComponent comp, Widget w)
SCR_SubMenuBase	OnTabHide (SCR_TabViewComponent comp, Widget w)
SCR_SubMenuBase	OnTabRemove (SCR_TabViewComponent comp, Widget w)
SCR_SubMenuBase	OnTabChange (SCR_TabViewComponent comp, Widget w)
void	OnRequestCloseMenu ()
void	OnRequestTabChange (int newTab, int oldTab)
SCR_TabViewComponent	GetTabView ()
int	GetSelectedTab ()
SCR_SubMenuBase	GetOpenedSubMenu ()
SCR_SubMenuBase	GetSubMenu (int index)
ScriptInvokerVoid	GetOnRequestCloseMenu ()

Static Protected Member Functions
static SCR_SuperMenuComponent	FindComponent (notnull Widget w)

Protected Attributes
ResourceName	m_sNavigationButtonLayout
string	m_sTabViewName
SCR_TabViewComponent	m_TabViewComponent
SCR_SubMenuBase	m_OpenedSubmenu
ref array< SCR_SubMenuBase >	m_aSubMenus = {}
Widget	m_wMenuRoot
ref ScriptInvokerVoid	m_OnRequestCloseMenu

Detailed Description

Handles tab menus. Requires:

• TabView component, to handle displaying tabs
• Each tab layout to have a SCR_SubMenuBase component, to take care of the tab's needs
• A manager/brain class (like SCR_SuperMenuBase or SCR_TabDialog) to call Init() and the main events

Also determines which button layouts are used in the sub menus, so they are consistent across al tabs

Definition at line 10 of file SCR_SuperMenuComponent.c.

Member Function Documentation

FindComponent()

SCR_SuperMenuComponent SCR_SuperMenuComponent::FindComponent ( notnull Widget w )

inlinestaticprotected

Definition at line 255 of file SCR_SuperMenuComponent.c.

GetOnRequestCloseMenu()

ScriptInvokerVoid SCR_SuperMenuComponent::GetOnRequestCloseMenu ( )

inlineprotected

Definition at line 264 of file SCR_SuperMenuComponent.c.

GetOpenedSubMenu()

SCR_SubMenuBase SCR_SuperMenuComponent::GetOpenedSubMenu ( )

inlineprotected

Definition at line 238 of file SCR_SuperMenuComponent.c.

GetSelectedTab()

int SCR_SuperMenuComponent::GetSelectedTab ( )

inlineprotected

Definition at line 232 of file SCR_SuperMenuComponent.c.

GetSubMenu()

SCR_SubMenuBase SCR_SuperMenuComponent::GetSubMenu ( int index )

inlineprotected

Definition at line 245 of file SCR_SuperMenuComponent.c.

GetTabView()

SCR_TabViewComponent SCR_SuperMenuComponent::GetTabView ( )

inlineprotected

Definition at line 226 of file SCR_SuperMenuComponent.c.

Init()

void SCR_SuperMenuComponent::Init ( Widget menuRoot )

inlineprotected

Definition at line 34 of file SCR_SuperMenuComponent.c.

OnMenuClose()

void SCR_SuperMenuComponent::OnMenuClose ( )

inlineprotected

Definition at line 112 of file SCR_SuperMenuComponent.c.

OnMenuFocusGained()

void SCR_SuperMenuComponent::OnMenuFocusGained ( )

inlineprotected

Definition at line 98 of file SCR_SuperMenuComponent.c.

OnMenuFocusLost()

void SCR_SuperMenuComponent::OnMenuFocusLost ( )

inlineprotected

Definition at line 105 of file SCR_SuperMenuComponent.c.

OnMenuHide()

void SCR_SuperMenuComponent::OnMenuHide ( )

inlineprotected

Definition at line 84 of file SCR_SuperMenuComponent.c.

OnMenuShow()

void SCR_SuperMenuComponent::OnMenuShow ( )

inlineprotected

Definition at line 77 of file SCR_SuperMenuComponent.c.

OnMenuUpdate()

void SCR_SuperMenuComponent::OnMenuUpdate ( float tDelta )

inlineprotected

Definition at line 91 of file SCR_SuperMenuComponent.c.

OnRequestCloseMenu()

void SCR_SuperMenuComponent::OnRequestCloseMenu ( )

inlineprotected

Definition at line 211 of file SCR_SuperMenuComponent.c.

OnRequestTabChange()

void SCR_SuperMenuComponent::OnRequestTabChange ( int newTab, int oldTab )

inlineprotected

Definition at line 218 of file SCR_SuperMenuComponent.c.

OnTabChange()

SCR_SubMenuBase SCR_SuperMenuComponent::OnTabChange ( SCR_TabViewComponent comp, Widget w )

inlineprotected

Definition at line 196 of file SCR_SuperMenuComponent.c.

OnTabCreate()

SCR_SubMenuBase SCR_SuperMenuComponent::OnTabCreate ( SCR_TabViewComponent comp, Widget w, int index )

inlineprotected

Definition at line 128 of file SCR_SuperMenuComponent.c.

OnTabHide()

SCR_SubMenuBase SCR_SuperMenuComponent::OnTabHide ( SCR_TabViewComponent comp, Widget w )

inlineprotected

Definition at line 165 of file SCR_SuperMenuComponent.c.

OnTabRemove()

SCR_SubMenuBase SCR_SuperMenuComponent::OnTabRemove ( SCR_TabViewComponent comp, Widget w )

inlineprotected

Definition at line 180 of file SCR_SuperMenuComponent.c.

OnTabShow()

SCR_SubMenuBase SCR_SuperMenuComponent::OnTabShow ( SCR_TabViewComponent comp, Widget w )

inlineprotected

Definition at line 149 of file SCR_SuperMenuComponent.c.

Member Data Documentation

m_aSubMenus

ref array<SCR_SubMenuBase> SCR_SuperMenuComponent::m_aSubMenus = {}

protected

Definition at line 23 of file SCR_SuperMenuComponent.c.

m_OnRequestCloseMenu

ref ScriptInvokerVoid SCR_SuperMenuComponent::m_OnRequestCloseMenu

protected

Definition at line 28 of file SCR_SuperMenuComponent.c.

m_OpenedSubmenu

SCR_SubMenuBase SCR_SuperMenuComponent::m_OpenedSubmenu

protected

Definition at line 20 of file SCR_SuperMenuComponent.c.

m_sNavigationButtonLayout

ResourceName SCR_SuperMenuComponent::m_sNavigationButtonLayout

protected

Definition at line 13 of file SCR_SuperMenuComponent.c.

m_sTabViewName

string SCR_SuperMenuComponent::m_sTabViewName

protected

Definition at line 16 of file SCR_SuperMenuComponent.c.

m_TabViewComponent

SCR_TabViewComponent SCR_SuperMenuComponent::m_TabViewComponent

protected

Definition at line 18 of file SCR_SuperMenuComponent.c.

m_wMenuRoot

Widget SCR_SuperMenuComponent::m_wMenuRoot

protected

Definition at line 25 of file SCR_SuperMenuComponent.c.

---

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

• scripts/Game/UI/Menu/SubMenu/SCR_SuperMenuComponent.c