SCR_SelectionMenuEntryComponent Interface Reference

Base widget component for selection menu entries Handles mainly mouse interaction with the entry layout. More...

Inheritance diagram for SCR_SelectionMenuEntryComponent:

Public Member Functions
ScriptInvoker	GetOnMouseEnter ()
ScriptInvoker	GetOnMouseLeave ()
ScriptInvoker	GetOnClick ()
override void	HandlerAttached (Widget w)
override bool	OnMouseEnter (Widget w, int x, int y)
override bool	OnMouseLeave (Widget w, Widget enterW, int x, int y)
override bool	OnClick (Widget w, int x, int y, int button)
void	SetEnabled (bool enabled)
float	GetLayoutSize ()
void	SetEntry (SCR_SelectionMenuEntry entry)
	Set entry holding data driving this visuals.
void	SetEntryText (string str)
float	GetOriginalSize ()
float	GetAdjustedSize ()
Public Member Functions inherited from SCR_ScriptedWidgetComponent
Widget	GetRootWidget ()
bool	IsVisible ()

Protected Member Functions
void	InvokeOnMouseEnter ()
void	InvokeOnMouseLeave ()
void	InvokeOnClick ()

Protected Attributes
float	m_fDisabledOpacity
string	m_sSizeLayout
string	m_sEntryText
SCR_SelectionMenuEntry	m_Entry
bool	m_bEnabled = true
float	m_fOriginalSize
float	m_fAdjustedSize
Widget	m_wSizeLayout
TextWidget	m_wEntryText
ref ScriptInvoker< SCR_SelectionMenuEntryComponent >	m_OnMouseEnter
ref ScriptInvoker< SCR_SelectionMenuEntryComponent >	m_OnMouseLeave
Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget	m_wRoot

Additional Inherited Members
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 inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Detailed Description

Base widget component for selection menu entries Handles mainly mouse interaction with the entry layout.

Member Function Documentation

GetAdjustedSize()

float SCR_SelectionMenuEntryComponent.GetAdjustedSize

(

)

GetLayoutSize()

float SCR_SelectionMenuEntryComponent.GetLayoutSize

(

)

GetOnClick()

ScriptInvoker SCR_SelectionMenuEntryComponent.GetOnClick

(

)

GetOnMouseEnter()

ScriptInvoker SCR_SelectionMenuEntryComponent.GetOnMouseEnter

(

)

GetOnMouseLeave()

ScriptInvoker SCR_SelectionMenuEntryComponent.GetOnMouseLeave

(

)

GetOriginalSize()

float SCR_SelectionMenuEntryComponent.GetOriginalSize

(

)

HandlerAttached()

override void SCR_SelectionMenuEntryComponent.HandlerAttached

(

Widget

w

)

Implements SCR_ScriptedWidgetComponent.

Implemented in SCR_SelectionMenuEntryCommandComponent, SCR_SelectionMenuEntryIconComponent, SCR_SelectionMenuEntryPreviewComponent, and SCR_VONEntryComponent.

InvokeOnClick()

void SCR_SelectionMenuEntryComponent.InvokeOnClick ( )

protected

InvokeOnMouseEnter()

void SCR_SelectionMenuEntryComponent.InvokeOnMouseEnter ( )

protected

InvokeOnMouseLeave()

void SCR_SelectionMenuEntryComponent.InvokeOnMouseLeave ( )

protected

OnClick()

override bool SCR_SelectionMenuEntryComponent.OnClick	(	Widget	w,
		int	x,
		int	y,
		int	button )

Implements SCR_ScriptedWidgetComponent.

OnMouseEnter()

override bool SCR_SelectionMenuEntryComponent.OnMouseEnter	(	Widget	w,
		int	x,
		int	y )

OnMouseLeave()

override bool SCR_SelectionMenuEntryComponent.OnMouseLeave	(	Widget	w,
		Widget	enterW,
		int	x,
		int	y )

SetEnabled()

void SCR_SelectionMenuEntryComponent.SetEnabled

(

bool

enabled

)

SetEntry()

void SCR_SelectionMenuEntryComponent.SetEntry

(

SCR_SelectionMenuEntry

entry

)

Set entry holding data driving this visuals.

Implemented in SCR_SelectionMenuEntryIconComponent.

SetEntryText()

void SCR_SelectionMenuEntryComponent.SetEntryText

(

string

str

)

Member Data Documentation

m_bEnabled

bool SCR_SelectionMenuEntryComponent.m_bEnabled = true

protected

m_Entry

SCR_SelectionMenuEntry SCR_SelectionMenuEntryComponent.m_Entry

protected

m_fAdjustedSize

float SCR_SelectionMenuEntryComponent.m_fAdjustedSize

protected

m_fDisabledOpacity

float SCR_SelectionMenuEntryComponent.m_fDisabledOpacity

protected

m_fOriginalSize

float SCR_SelectionMenuEntryComponent.m_fOriginalSize

protected

m_OnMouseEnter

ref ScriptInvoker<SCR_SelectionMenuEntryComponent> SCR_SelectionMenuEntryComponent.m_OnMouseEnter

protected

m_OnMouseLeave

ref ScriptInvoker<SCR_SelectionMenuEntryComponent> SCR_SelectionMenuEntryComponent.m_OnMouseLeave

protected

m_sEntryText

string SCR_SelectionMenuEntryComponent.m_sEntryText

protected

m_sSizeLayout

string SCR_SelectionMenuEntryComponent.m_sSizeLayout

protected

m_wEntryText

TextWidget SCR_SelectionMenuEntryComponent.m_wEntryText

protected

m_wSizeLayout

Widget SCR_SelectionMenuEntryComponent.m_wSizeLayout

protected

---

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

• Game/UI/HUD/SelectionMenu/SCR_SelectionMenuEntryComponent.c