SCR_LoadingOverlay Interface Reference

Inheritance diagram for SCR_LoadingOverlay:

Public Member Functions
void	HideAndDelete ()
	Hides the overlay. The overlay will be destroyed, and the SCR_LoadingOverlay component will be deleted.
void	SetShown (bool show)
	Shows or hides the overlay. The overlay is not destroyed if hidden and can be shown again.
void	SetText (string text)
void	ShowBackground (bool show)
void	ShowBlur (bool show)
Widget	GetRootWidget ()
void	SetFocus ()
	Sets the fake button as focused widget, can be used if you need to reset focus from the widgets under this loading overlay.
override void	HandlerAttached (Widget w)
override bool	OnUpdate (Widget w)
override bool	OnClick (Widget w, int x, int y, int button)
override bool	OnModalResult (Widget w, int x, int y, int code, int result)
override bool	OnDoubleClick (Widget w, int x, int y, int button)
override bool	OnSelect (Widget w, int x, int y)
override bool	OnItemSelected (Widget w, int x, int y, int row, int column, int oldRow, int oldColumn)
override bool	OnFocus (Widget w, int x, int y)
override bool	OnFocusLost (Widget w, int x, int y)
override bool	OnMouseEnter (Widget w, int x, int y)
override bool	OnMouseLeave (Widget w, Widget enterW, int x, int y)
override bool	OnMouseWheel (Widget w, int x, int y, int wheel)
override bool	OnMouseButtonDown (Widget w, int x, int y, int button)
override bool	OnMouseButtonUp (Widget w, int x, int y, int button)
override bool	OnController (Widget w, int control, int value)
	control is one of ControlID
override bool	OnKeyDown (Widget w, int x, int y, int key)
override bool	OnKeyUp (Widget w, int x, int y, int key)
override bool	OnKeyPress (Widget w, int x, int y, int key)
override bool	OnChange (Widget w, int x, int y, bool finished)
override bool	OnResize (Widget w, int x, int y)
override bool	OnModalClickOut (Widget modalRoot, int x, int y, int button)

Static Public Member Functions
static SCR_LoadingOverlay	ShowForWidget (Widget targetWidget, string text=string.Empty, bool showBlur=true, bool showBackground=true)
	Shows an overlay over target widget You can call it multiple times for same widget.
static void	HideForWidget (Widget targetWidget)
	Hides overlay for given target widget.

Public Attributes
Widget	m_wRoot
ref SCR_LoadingOverlayWidgets	widgets
SCR_LoadingOverlayHelperComponent	m_Helper
bool	m_bShownAtStart

Protected Member Functions
void	Init (Widget overlayRoot, SCR_LoadingOverlayHelperComponent helper)
void	SetSizeFromTarget ()

Protected Attributes
bool	m_bRenderTopMost = false
bool	m_bShown = true
bool	m_bShowBackground

Member Function Documentation

GetRootWidget()

Widget SCR_LoadingOverlay.GetRootWidget

(

)

HandlerAttached()

override void SCR_LoadingOverlay.HandlerAttached

(

Widget

w

)

HideAndDelete()

void SCR_LoadingOverlay.HideAndDelete

(

)

Hides the overlay. The overlay will be destroyed, and the SCR_LoadingOverlay component will be deleted.

HideForWidget()

static void SCR_LoadingOverlay.HideForWidget ( Widget  targetWidget )

static

Hides overlay for given target widget.

Init()

void SCR_LoadingOverlay.Init ( Widget  overlayRoot, SCR_LoadingOverlayHelperComponent  helper  )

protected

OnChange()

override bool SCR_LoadingOverlay.OnChange	(	Widget	w,
		int	x,
		int	y,
		bool	finished
	)

OnClick()

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

OnController()

override bool SCR_LoadingOverlay.OnController	(	Widget	w,
		int	control,
		int	value
	)

control is one of ControlID

OnDoubleClick()

override bool SCR_LoadingOverlay.OnDoubleClick	(	Widget	w,
		int	x,
		int	y,
		int	button
	)

OnFocus()

override bool SCR_LoadingOverlay.OnFocus	(	Widget	w,
		int	x,
		int	y
	)

OnFocusLost()

override bool SCR_LoadingOverlay.OnFocusLost	(	Widget	w,
		int	x,
		int	y
	)

OnItemSelected()

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

OnKeyDown()

override bool SCR_LoadingOverlay.OnKeyDown	(	Widget	w,
		int	x,
		int	y,
		int	key
	)

OnKeyPress()

override bool SCR_LoadingOverlay.OnKeyPress	(	Widget	w,
		int	x,
		int	y,
		int	key
	)

OnKeyUp()

override bool SCR_LoadingOverlay.OnKeyUp	(	Widget	w,
		int	x,
		int	y,
		int	key
	)

OnModalClickOut()

override bool SCR_LoadingOverlay.OnModalClickOut	(	Widget	modalRoot,
		int	x,
		int	y,
		int	button
	)

OnModalResult()

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

OnMouseButtonDown()

override bool SCR_LoadingOverlay.OnMouseButtonDown	(	Widget	w,
		int	x,
		int	y,
		int	button
	)

OnMouseButtonUp()

override bool SCR_LoadingOverlay.OnMouseButtonUp	(	Widget	w,
		int	x,
		int	y,
		int	button
	)

OnMouseEnter()

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

OnMouseLeave()

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

OnMouseWheel()

override bool SCR_LoadingOverlay.OnMouseWheel	(	Widget	w,
		int	x,
		int	y,
		int	wheel
	)

OnResize()

override bool SCR_LoadingOverlay.OnResize	(	Widget	w,
		int	x,
		int	y
	)

OnSelect()

override bool SCR_LoadingOverlay.OnSelect	(	Widget	w,
		int	x,
		int	y
	)

OnUpdate()

override bool SCR_LoadingOverlay.OnUpdate

(

Widget

w

)

SetFocus()

void SCR_LoadingOverlay.SetFocus

(

)

Sets the fake button as focused widget, can be used if you need to reset focus from the widgets under this loading overlay.

SetShown()

void SCR_LoadingOverlay.SetShown

(

bool

show

)

Shows or hides the overlay. The overlay is not destroyed if hidden and can be shown again.

SetSizeFromTarget()

void SCR_LoadingOverlay.SetSizeFromTarget ( )

protected

SetText()

void SCR_LoadingOverlay.SetText

(

string

text

)

ShowBackground()

void SCR_LoadingOverlay.ShowBackground

(

bool

show

)

ShowBlur()

void SCR_LoadingOverlay.ShowBlur

(

bool

show

)

ShowForWidget()

static SCR_LoadingOverlay SCR_LoadingOverlay.ShowForWidget ( Widget  targetWidget, string  text = string::Empty, bool  showBlur = true, bool  showBackground = true  )

static

Shows an overlay over target widget You can call it multiple times for same widget.

If an overlay already exists, new one will not be created, and the old overlay will be returned.

Member Data Documentation

m_bRenderTopMost

bool SCR_LoadingOverlay.m_bRenderTopMost = false

protected

m_bShowBackground

bool SCR_LoadingOverlay.m_bShowBackground

protected

m_bShown

bool SCR_LoadingOverlay.m_bShown = true

protected

m_bShownAtStart

bool SCR_LoadingOverlay.m_bShownAtStart

m_Helper

SCR_LoadingOverlayHelperComponent SCR_LoadingOverlay.m_Helper

m_wRoot

Widget SCR_LoadingOverlay.m_wRoot

widgets

ref SCR_LoadingOverlayWidgets SCR_LoadingOverlay.widgets

---

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

• Game/UI/Components/WidgetLibrary/SCR_LoadingOverlay.c