Base class for menus in menu manager order callbacks call: opening: 1) OnMenuInit - called during load, when MenuManager loading menus config 2) OnMenuOpen - called when menu is beeing open 3) OnMenuShow 4) OnMenuFocusGained 5) OnMenuOpened - called after menu is opened and is ready. More...

Inheritance diagram for MenuBase:

[legend]

Public Member Functions
proto native int	GetUserData ()

proto native Widget	GetRootWidget ()

proto external MenuBase	BindItem (string menuItemName, MenuItemCallback callback)

proto native MenuBase	SetLabel (string menuItemName, string text)

proto native Widget	GetItemWidget (string menuItemName)

proto native bool	AddMenuItem (string menuItemName, Widget w, string actionName)

proto native bool	RemoveMenuItem (string menuItemName)

proto native MenuManager	GetManager ()

proto native void	SetActionContext (string actionContextName)

proto native bool	IsFocused ()

proto native bool	IsOpen ()

proto native void	Close ()

void	CloseMe ()

void	OnMenuFocusGained ()

void	OnMenuFocusLost ()

void	OnMenuShow ()

void	OnMenuHide ()

void	OnMenuOpen ()

void	OnMenuOpened ()

void	OnMenuClose ()

void	OnMenuInit ()

void	OnMenuUpdate (float tDelta)

void	OnMenuItem (string menuItemName, bool changed, bool finished)

Public Member Functions inherited from ScriptedWidgetEventHandler
bool	OnClick (Widget w, int x, int y, int button)

bool	OnModalResult (Widget w, int x, int y, int code, int result)

bool	OnDoubleClick (Widget w, int x, int y, int button)

bool	OnSelect (Widget w, int x, int y)

bool	OnItemSelected (Widget w, int x, int y, int row, int column, int oldRow, int oldColumn)

bool	OnFocus (Widget w, int x, int y)

bool	OnFocusLost (Widget w, int x, int y)

bool	OnMouseEnter (Widget w, int x, int y)

bool	OnMouseLeave (Widget w, Widget enterW, int x, int y)

bool	OnMouseWheel (Widget w, int x, int y, int wheel)

bool	OnMouseButtonDown (Widget w, int x, int y, int button)

bool	OnMouseButtonUp (Widget w, int x, int y, int button)

bool	OnController (Widget w, int control, int value)
	control is one of ControlID

bool	OnKeyDown (Widget w, int x, int y, int key)

bool	OnKeyUp (Widget w, int x, int y, int key)

bool	OnKeyPress (Widget w, int x, int y, int key)

bool	OnChange (Widget w, int x, int y, bool finished)

bool	OnNeedScroll (Widget w, int x, int y, float prevScrollPosX, float prevScrollPosY, float newScrollPosX, float newScrollPosY)

bool	OnResize (Widget w, int x, int y)

bool	OnChildAdd (Widget w, Widget child)

bool	OnChildRemove (Widget w, Widget child)

bool	OnUpdate (Widget w)

bool	OnEvent (EventType eventType, Widget target, int parameter0, int parameter1)

bool	OnModalClickOut (Widget modalRoot, int x, int y, int button)

void	HandlerAttached (Widget w)

void	HandlerDeattached (Widget w)

Public Member Functions inherited from Managed
proto external ref Managed	Clone ()
	Return shallow copy of object, or null if it is not allowed (not public constructor)

Protected Member Functions
void	MenuBase ()

void	~MenuBase ()

Detailed Description

Base class for menus in menu manager order callbacks call: opening: 1) OnMenuInit - called during load, when MenuManager loading menus config 2) OnMenuOpen - called when menu is beeing open 3) OnMenuShow 4) OnMenuFocusGained 5) OnMenuOpened - called after menu is opened and is ready.

loop: OnMenuUpdate OnMenuItem

closing: 1) OnMenuFocusLost - called when menu is closed or other menu/dialog going to overlap the menu 2) OnMenuHide 3) OnMenuClose

Constructor & Destructor Documentation

◆ MenuBase()

void MenuBase.MenuBase ( )

protected

◆ ~MenuBase()

void MenuBase.~MenuBase ( )

protected

Member Function Documentation

◆ AddMenuItem()

proto native bool MenuBase.AddMenuItem	(	string	menuItemName,
		Widget	w,
		string	actionName
	)

◆ BindItem()

proto external MenuBase MenuBase.BindItem	(	string	menuItemName,
		MenuItemCallback	callback
	)

◆ Close()

proto native void MenuBase.Close ( )

◆ CloseMe()

void MenuBase.CloseMe ( )

◆ GetItemWidget()

proto native Widget MenuBase.GetItemWidget ( string menuItemName )

◆ GetManager()

proto native MenuManager MenuBase.GetManager ( )

◆ GetRootWidget()

proto native Widget MenuBase.GetRootWidget ( )

◆ GetUserData()

proto native int MenuBase.GetUserData ( )

◆ IsFocused()

proto native bool MenuBase.IsFocused ( )

◆ IsOpen()

proto native bool MenuBase.IsOpen ( )

◆ OnMenuClose()

void MenuBase.OnMenuClose ( )

◆ OnMenuFocusGained()

void MenuBase.OnMenuFocusGained ( )

◆ OnMenuFocusLost()

void MenuBase.OnMenuFocusLost ( )

◆ OnMenuHide()

void MenuBase.OnMenuHide ( )

◆ OnMenuInit()

void MenuBase.OnMenuInit ( )

◆ OnMenuItem()

void MenuBase.OnMenuItem	(	string	menuItemName,
		bool	changed,
		bool	finished
	)

◆ OnMenuOpen()

void MenuBase.OnMenuOpen ( )

◆ OnMenuOpened()

void MenuBase.OnMenuOpened ( )

◆ OnMenuShow()

void MenuBase.OnMenuShow ( )

◆ OnMenuUpdate()

void MenuBase.OnMenuUpdate ( float tDelta )

◆ RemoveMenuItem()

proto native bool MenuBase.RemoveMenuItem ( string menuItemName )

◆ SetActionContext()

proto native void MenuBase.SetActionContext ( string actionContextName )

◆ SetLabel()

proto native MenuBase MenuBase.SetLabel	(	string	menuItemName,
		string	text
	)

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

GameLib/menuManager.c

Public Member Functions

Protected Member Functions