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:

Public Member Functions
proto external int	GetUserData ()
	Returns user id uint, set on menu opening.

proto external MenuManager	GetManager ()

proto external Widget	GetRootWidget ()

proto external Widget	GetItemWidget (string menuItemName)
	Returns pointer to widget associated with MenuItem (defined in menu config). If there is no MenuItem with given name, or there is no widget associated to it, returns nullptr.

proto external MenuBase	SetLabel (string menuItemName, string text)
	Sets text to widget associated with MenuItem (works only with text containing widgets like ButtonWidget, TextWidget, MultilineTextWidget, RichTextWidget, on other widgets do nothing)

proto external void	Close ()
	Put menu into queue for closing (which is processed during next MenuManeger update)

proto external bool	IsFocused ()

proto external bool	IsOpen ()

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

proto external bool	RemoveMenuItem (string menuItemName)

proto external void	SetActionContext (string actionContextName)

proto MenuBase	BindItem (string menuItemName, MenuItemCallback callback)
	Registers MenuItem callback.

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)
	Called when a button is clicked (including buttons on widgets like checkboxes, scrollbars, combo-boxes).

bool	OnShow (Widget w)
	Called when a widget's visibility flag has changed and the widget is now flagged as visible.

bool	OnHide (Widget w)
	Called when a widget's visibility flag has changed and the widget is now flagged as hidden.

bool	OnEnable (Widget w)
	Called when a widget's enabled/disabled state has changed and the widget is now enabled.

bool	OnDisable (Widget w)
	Called when a widget's enabled/disabled state has changed and the widget is now disabled.

bool	OnModalClosed (Widget modalRoot)
	Called when a modal widget is closed.

bool	OnModalClickOut (Widget modalRoot, int x, int y, int button)
	Called when the user clicks outside a modal widget.

bool	OnDoubleClick (Widget w, int x, int y, int button)
	Called when the user double-clicks on a widget.

bool	OnItemSelected (Widget w, int row, int column, int oldRow, int oldColumn)
	Called when the user selects an item in a listbox.

bool	OnFocus (Widget w, int x, int y)
	Called when a widget is focused.

bool	OnFocusLost (Widget w, int x, int y)
	Called when a widget loses focus.

bool	OnMouseEnter (Widget w, int x, int y)
	Called when a widget gets under the mouse cursor.

bool	OnMouseLeave (Widget w, Widget enterW, int x, int y)
	Called when a widget is no longer under the mouse cursor.

bool	OnMouseWheel (Widget w, int x, int y, int wheel)
	Called on a widget under the cursor when the user uses the mouse wheel.

bool	OnMouseButtonDown (Widget w, int x, int y, int button)
	Called on a widget under the cursor when the user presses a mouse button.

bool	OnMouseButtonUp (Widget w, int x, int y, int button)
	Called when the user releases a mouse button on the widget under the cursor and also on the widget where the mouse down event was triggered.

bool	OnLinkEnter (Widget w, int x, int y, string link)
	Called when a hyper link gets under the mouse cursor.

bool	OnLinkLeave (Widget w, int x, int y, string link)
	Called when a hyper link is no longer under the mouse cursor.

bool	OnLinkClick (Widget w, int x, int y, int button, string link)
	Called when a hyper link is clicked.

bool	OnController (Widget w, ControlID control, int value)
	Called on a focused widget when the user triggers a controller action via keyboard or game device.

bool	OnChar (Widget w, int charCode)
	Called when the user types on a focused widget that accepts text input (EditBoxWidget, MultilineEditBox, Listbox widgets).

bool	OnChange (Widget w, bool finished)
	Called when the internal state of a widget is changed in widgets with internal states (CheckBoxWidget, EditBoxWidget, MultilineEditBox, SliderWidget, ComboBoxWidget).

bool	OnWriteModeEnter (Widget w)
	Called when the user enter write mode on a edit box (EditBoxWidget, MultilineEditBox).

bool	OnWriteModeLeave (Widget w)
	Called when the user leave write mode on a edit box (EditBoxWidget, MultilineEditBox).

bool	OnChildAdd (Widget w, Widget child)
	Called when a child widget is added to a widget.

bool	OnChildRemove (Widget w, Widget child)
	Called when a child widget is removed from a widget.

bool	OnCustomEvent (Widget w, int iUserData, Managed pUserData)
	Called when event is emitted by call of Widget.EmitCustomEvent.

bool	OnUpdate (Widget w)
	Called when a widget is updated due to a layout change.

void	HandlerAttached (Widget w)
	Called when a new handler (widget component) is attached to a widget.

void	HandlerDeattached (Widget w)
	Called when a handler (widget component) is detached from a widget.

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)

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

Member Function Documentation

◆ AddMenuItem()

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

◆ BindItem()

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

Registers MenuItem callback.

Callback is called when:

Widget associated with MenuItem is clicked or changed (details are contained in MenuItemEvent argument of callback)
InputAction associated with MenuItem is triggered

◆ Close()

proto external void MenuBase.Close ( )

Put menu into queue for closing (which is processed during next MenuManeger update)

◆ GetItemWidget()

proto external Widget MenuBase.GetItemWidget ( string menuItemName )

Returns pointer to widget associated with MenuItem (defined in menu config). If there is no MenuItem with given name, or there is no widget associated to it, returns nullptr.

◆ GetManager()

proto external MenuManager MenuBase.GetManager ( )

◆ GetRootWidget()

proto external Widget MenuBase.GetRootWidget ( )

◆ GetUserData()

proto external int MenuBase.GetUserData ( )

Returns user id uint, set on menu opening.

◆ IsFocused()

proto external bool MenuBase.IsFocused ( )

◆ IsOpen()

proto external 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 external bool MenuBase.RemoveMenuItem ( string menuItemName )

◆ SetActionContext()

proto external void MenuBase.SetActionContext ( string actionContextName )

◆ SetLabel()

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

Sets text to widget associated with MenuItem (works only with text containing widgets like ButtonWidget, TextWidget, MultilineTextWidget, RichTextWidget, on other widgets do nothing)

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

GameLib/generated/Menu/MenuBase.c

Public Member Functions