SCR_SuperMenuComponent Interface Reference

Handles tab menus. More...

Inheritance diagram for SCR_SuperMenuComponent:

Public 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)
SCR_TabViewComponent	GetTabView ()
int	GetSelectedTab ()
SCR_SubMenuBase	GetOpenedSubMenu ()
SCR_SubMenuBase	GetSubMenu (int index)
ScriptInvokerVoid	GetOnRequestCloseMenu ()
Public Member Functions inherited from SCR_ScriptedWidgetComponent
override void	HandlerAttached (Widget w)
override bool	OnClick (Widget w, int x, int y, int button)
Widget	GetRootWidget ()
bool	IsVisible ()

Static Public Member Functions
static SCR_SuperMenuComponent	FindComponent (notnull Widget w)
Static Public Member Functions inherited from SCR_ScriptedWidgetComponent
static SCR_ScriptedWidgetComponent	GetComponent (TypeName componentType, string name, Widget parent, bool searchAllChildren=true)
	Base method for component lookup through the widget library.

Public Attributes
Widget	m_wMenuRoot
Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Protected Member Functions
void	OnRequestCloseMenu ()
void	OnRequestTabChange (int newTab, int oldTab)

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

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

Member Function Documentation

FindComponent()

static SCR_SuperMenuComponent SCR_SuperMenuComponent.FindComponent ( notnull Widget w )

static

GetOnRequestCloseMenu()

ScriptInvokerVoid SCR_SuperMenuComponent.GetOnRequestCloseMenu

(

)

GetOpenedSubMenu()

SCR_SubMenuBase SCR_SuperMenuComponent.GetOpenedSubMenu

(

)

GetSelectedTab()

int SCR_SuperMenuComponent.GetSelectedTab

(

)

GetSubMenu()

SCR_SubMenuBase SCR_SuperMenuComponent.GetSubMenu

(

int

index

)

GetTabView()

SCR_TabViewComponent SCR_SuperMenuComponent.GetTabView

(

)

Init()

void SCR_SuperMenuComponent.Init

(

Widget

menuRoot

)

OnMenuClose()

void SCR_SuperMenuComponent.OnMenuClose

(

)

Implemented in SCR_ModDetailsSuperMenuComponent.

OnMenuFocusGained()

void SCR_SuperMenuComponent.OnMenuFocusGained

(

)

OnMenuFocusLost()

void SCR_SuperMenuComponent.OnMenuFocusLost

(

)

OnMenuHide()

void SCR_SuperMenuComponent.OnMenuHide

(

)

Implemented in SCR_ModDetailsSuperMenuComponent.

OnMenuShow()

void SCR_SuperMenuComponent.OnMenuShow

(

)

Implemented in SCR_ModDetailsSuperMenuComponent.

OnMenuUpdate()

void SCR_SuperMenuComponent.OnMenuUpdate

(

float

tDelta

)

OnRequestCloseMenu()

void SCR_SuperMenuComponent.OnRequestCloseMenu ( )

protected

OnRequestTabChange()

void SCR_SuperMenuComponent.OnRequestTabChange ( int newTab, int oldTab )

protected

OnTabChange()

SCR_SubMenuBase SCR_SuperMenuComponent.OnTabChange	(	SCR_TabViewComponent	comp,
		Widget	w )

OnTabCreate()

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

Implemented in SCR_ModDetailsSuperMenuComponent.

OnTabHide()

SCR_SubMenuBase SCR_SuperMenuComponent.OnTabHide	(	SCR_TabViewComponent	comp,
		Widget	w )

OnTabRemove()

SCR_SubMenuBase SCR_SuperMenuComponent.OnTabRemove	(	SCR_TabViewComponent	comp,
		Widget	w )

OnTabShow()

SCR_SubMenuBase SCR_SuperMenuComponent.OnTabShow	(	SCR_TabViewComponent	comp,
		Widget	w )

Implemented in SCR_ModDetailsSuperMenuComponent.

Member Data Documentation

m_aSubMenus

ref array<SCR_SubMenuBase> SCR_SuperMenuComponent.m_aSubMenus = {}

protected

m_OnRequestCloseMenu

ref ScriptInvokerVoid SCR_SuperMenuComponent.m_OnRequestCloseMenu

protected

m_OpenedSubmenu

SCR_SubMenuBase SCR_SuperMenuComponent.m_OpenedSubmenu

protected

m_sNavigationButtonLayout

ResourceName SCR_SuperMenuComponent.m_sNavigationButtonLayout

protected

m_sTabViewName

string SCR_SuperMenuComponent.m_sTabViewName

protected

m_TabViewComponent

SCR_TabViewComponent SCR_SuperMenuComponent.m_TabViewComponent

protected

m_wMenuRoot

Widget SCR_SuperMenuComponent.m_wMenuRoot

---

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

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