SCR_MenuHelper Interface Reference

Static Public Member Functions
static ScriptInvokerActiveWidgetInteraction	GetOnActiveWidgetInteraction ()
static ScriptInvokerDialog	GetOnDialogOpen ()
static ScriptInvokerDialog	GetOnDialogClose ()
static ScriptInvokerMenu	GetOnMenuOpen ()
static ScriptInvokerMenu	GetOnMenuOpened ()
static ScriptInvokerMenu	GetOnMenuClose ()
static ScriptInvokerMenu	GetOnMenuFocusGained ()
static ScriptInvokerMenu	GetOnMenuFocusLost ()
static ScriptInvokerMenu	GetOnMenuShow ()
static ScriptInvokerMenu	GetOnMenuHide ()
static ScriptInvokerTabView	GetOnTabChange ()
static void	SetActiveWidgetInteractionState (bool isActive, int delay=0)
	Navigation buttons are bound to this delegate to disable themselves during edit/combo boxes interaction and prevent reenabling Edit boxes and dropdown menus call this method as a substitute for the lack of events when starting and finishing txt editing / dropdown interaction.
static bool	IsInTopMenu (notnull Widget componentRoot)
	NB: This will return false if the widget is in a DIALOG on top of the MENU!!!
static void	OnDialogOpen (DialogUI dialog)
	Methods to keep track of current dialogs.
static void	OnDialogClose (DialogUI dialog)
	Called by DialogUI.
static void	OnMenuOpen (ChimeraMenuBase menu)
	Called by ChimeraMenuBase SCR_ScriptedWidgetTooltip uses this to make sure the tooltip is removed when the menu changes.
static void	OnMenuOpened (ChimeraMenuBase menu)
	Called by ChimeraMenuBase.
static void	OnMenuClose (ChimeraMenuBase menu)
	Called by ChimeraMenuBase.
static void	OnMenuFocusGained (ChimeraMenuBase menu)
	Called by ChimeraMenuBase.
static void	OnMenuFocusLost (ChimeraMenuBase menu)
	Called by ChimeraMenuBase.
static void	OnMenuShow (ChimeraMenuBase menu)
	Called by ChimeraMenuBase.
static void	OnMenuHide (ChimeraMenuBase menu)
	Called by ChimeraMenuBase.
static void	OnTabChange (SCR_TabViewComponent tabView, Widget widget)
	Called by SCR_TabViewComponent.

Static Protected Attributes
static ref ScriptInvokerActiveWidgetInteraction	m_OnActiveWidgetInteraction
static ref ScriptInvokerDialog	m_OnDialogOpen
static ref ScriptInvokerDialog	m_OnDialogClose
static ref ScriptInvokerMenu	m_OnMenuOpen
static ref ScriptInvokerMenu	m_OnMenuOpened
static ref ScriptInvokerMenu	m_OnMenuClose
static ref ScriptInvokerMenu	m_OnMenuFocusGained
static ref ScriptInvokerMenu	m_OnMenuFocusLost
static ref ScriptInvokerMenu	m_OnMenuShow
static ref ScriptInvokerMenu	m_OnMenuHide
static ref ScriptInvokerTabView	m_OnTabChange

Member Function Documentation

GetOnActiveWidgetInteraction()

static ScriptInvokerActiveWidgetInteraction SCR_MenuHelper.GetOnActiveWidgetInteraction ( )

static

GetOnDialogClose()

static ScriptInvokerDialog SCR_MenuHelper.GetOnDialogClose ( )

static

GetOnDialogOpen()

static ScriptInvokerDialog SCR_MenuHelper.GetOnDialogOpen ( )

static

GetOnMenuClose()

static ScriptInvokerMenu SCR_MenuHelper.GetOnMenuClose ( )

static

GetOnMenuFocusGained()

static ScriptInvokerMenu SCR_MenuHelper.GetOnMenuFocusGained ( )

static

GetOnMenuFocusLost()

static ScriptInvokerMenu SCR_MenuHelper.GetOnMenuFocusLost ( )

static

GetOnMenuHide()

static ScriptInvokerMenu SCR_MenuHelper.GetOnMenuHide ( )

static

GetOnMenuOpen()

static ScriptInvokerMenu SCR_MenuHelper.GetOnMenuOpen ( )

static

GetOnMenuOpened()

static ScriptInvokerMenu SCR_MenuHelper.GetOnMenuOpened ( )

static

GetOnMenuShow()

static ScriptInvokerMenu SCR_MenuHelper.GetOnMenuShow ( )

static

GetOnTabChange()

static ScriptInvokerTabView SCR_MenuHelper.GetOnTabChange ( )

static

IsInTopMenu()

static bool SCR_MenuHelper.IsInTopMenu ( notnull Widget  componentRoot )

static

NB: This will return false if the widget is in a DIALOG on top of the MENU!!!

OnDialogClose()

static void SCR_MenuHelper.OnDialogClose ( DialogUI  dialog )

static

Called by DialogUI.

OnDialogOpen()

static void SCR_MenuHelper.OnDialogOpen ( DialogUI  dialog )

static

Methods to keep track of current dialogs.

The MenuManager does not keep track of dialogs: GetTopMenu() only returns the last menu opened with OpenMenu(), not those opened with OpenDialog() Navigation buttons bind themselves to m_OnDialogOpen and m_OnDialogClose Called by DialogUI

OnMenuClose()

static void SCR_MenuHelper.OnMenuClose ( ChimeraMenuBase  menu )

static

Called by ChimeraMenuBase.

OnMenuFocusGained()

static void SCR_MenuHelper.OnMenuFocusGained ( ChimeraMenuBase  menu )

static

Called by ChimeraMenuBase.

OnMenuFocusLost()

static void SCR_MenuHelper.OnMenuFocusLost ( ChimeraMenuBase  menu )

static

Called by ChimeraMenuBase.

OnMenuHide()

static void SCR_MenuHelper.OnMenuHide ( ChimeraMenuBase  menu )

static

Called by ChimeraMenuBase.

OnMenuOpen()

static void SCR_MenuHelper.OnMenuOpen ( ChimeraMenuBase  menu )

static

Called by ChimeraMenuBase SCR_ScriptedWidgetTooltip uses this to make sure the tooltip is removed when the menu changes.

OnMenuOpened()

static void SCR_MenuHelper.OnMenuOpened ( ChimeraMenuBase  menu )

static

Called by ChimeraMenuBase.

OnMenuShow()

static void SCR_MenuHelper.OnMenuShow ( ChimeraMenuBase  menu )

static

Called by ChimeraMenuBase.

OnTabChange()

static void SCR_MenuHelper.OnTabChange ( SCR_TabViewComponent  tabView, Widget  widget  )

static

Called by SCR_TabViewComponent.

SetActiveWidgetInteractionState()

static void SCR_MenuHelper.SetActiveWidgetInteractionState ( bool  isActive, int  delay = 0  )

static

Navigation buttons are bound to this delegate to disable themselves during edit/combo boxes interaction and prevent reenabling Edit boxes and dropdown menus call this method as a substitute for the lack of events when starting and finishing txt editing / dropdown interaction.

Member Data Documentation

m_OnActiveWidgetInteraction

ref ScriptInvokerActiveWidgetInteraction SCR_MenuHelper.m_OnActiveWidgetInteraction

staticprotected

m_OnDialogClose

ref ScriptInvokerDialog SCR_MenuHelper.m_OnDialogClose

staticprotected

m_OnDialogOpen

ref ScriptInvokerDialog SCR_MenuHelper.m_OnDialogOpen

staticprotected

m_OnMenuClose

ref ScriptInvokerMenu SCR_MenuHelper.m_OnMenuClose

staticprotected

m_OnMenuFocusGained

ref ScriptInvokerMenu SCR_MenuHelper.m_OnMenuFocusGained

staticprotected

m_OnMenuFocusLost

ref ScriptInvokerMenu SCR_MenuHelper.m_OnMenuFocusLost

staticprotected

m_OnMenuHide

ref ScriptInvokerMenu SCR_MenuHelper.m_OnMenuHide

staticprotected

m_OnMenuOpen

ref ScriptInvokerMenu SCR_MenuHelper.m_OnMenuOpen

staticprotected

m_OnMenuOpened

ref ScriptInvokerMenu SCR_MenuHelper.m_OnMenuOpened

staticprotected

m_OnMenuShow

ref ScriptInvokerMenu SCR_MenuHelper.m_OnMenuShow

staticprotected

m_OnTabChange

ref ScriptInvokerTabView SCR_MenuHelper.m_OnTabChange

staticprotected

---

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

• Game/UI/Menu/SCR_MenuHelper.c