Inheritance diagram for SCR_ListViewComponent:

Public Member Functions
override void	HandlerAttached (Widget w)

override bool	OnUpdate (Widget w)

void	UpdateEntries (bool animated=false)
	Fill entries with data.

void	SetScrollbarVisible (bool visible)

void	FocusFirstAvailableEntry ()
	Find first available entry and focus it.

void	SetScrollbar (SCR_ScrollBarComponent scrollbar)

void	ActivateScrolling (bool activate)
	Activate scrolling with input action.

void	UpdateScrollbar ()

array< Widget >	GetEntryWidgets ()

float	ScrollableEntriesCount ()
	Return how many entries can be scrolled.

Widget	FirstAvailableEntry ()
	Return first that is visible and enabled.

Public Attributes
Widget	m_wRoot

Static Public Attributes
const string	WIDGET_VERTICAL_LIST = "VList"

const string	WIDGET_SIZE_SCROLL_OFFSET = "SizeScrollOffset"

const string	WIDGET_FOCUS_REST = "BtnFocusRest"

const int	ENTRY_FIRST = 0

Protected Member Functions
void	AccessingHandlers ()
	Get reference to all needed component for handling.

void	CreateEntriesWidgets ()
	Create server entries widget.

void	PostCheck ()

void	CreateEntry ()

int	CalculateLimit ()
	Calulate entry limit number from list size and entry size.

float	EntryFractionFromViewPos (float viewPos, float scrollPos)
	Get fraction of whole entry in percents from positon in list view in percent based on scroll postion EntryFractionFromViewPos(1, ) = how much of entry is missing from bottom view

void	CheckEntrySize ()
	Get size of widget entry used in list.

void	SetupEntryBehavior (Widget entry)
	Empty functions for setting up widget entry beavhior actions, callbacks, etc.

void	FillEntry (Widget w)
	Empty function for filling entries with data Override this to fill entries with data

void	ScrollOffsetMove (float scrollPos)
	Modify offset size to fake scrolling by scroll position.

void	ScrollWheelMove ()
	Scroll list based on input action.

void	StayOnLastEntry ()
	Kepp focus on last entry on scroll.

void	ScrollList (float step, float input)

float	ScrollMove (float step, float inputMove)

void	ChangeFocusWithoutAnimation (Widget w)

void	AnimateEntryOpacity (Widget w, int delay, float animTime, float opacityEnd, float opacityStart=-1)
	Setup opacity animation.

void	OpacityAnimation (Widget w, int time, float opacityEnd)

void	ClearServerList ()
	Clear widgets from server list.

void	OnMenuDown ()
	Scrolling with up/down buttons outside of list view Focus is focus rest widget

void	OnMenuUp ()
	Check stepping over limit up.

Protected Attributes
ResourceName	m_sEntry

string	m_sScrollAction

bool	m_bAutomaticEntriesLimit

int	m_iEntriesLimit

int	m_iEntriesBottomPadding

float	m_fScrollMove

float	m_fAnimationAppearTime

Widget	m_wVerticalList

SizeLayoutWidget	m_wSizeScrollOffset

Widget	m_wFocusRest

ref array< Widget >	m_aEntryWidgets = new array<Widget>

SCR_ScrollBarComponent	m_Scrollbar

float	m_fScrollPosition = 0

float	m_iLastScrollPosition = 0

float	m_iEntriesCount = 0

float	m_fEntryWidgetHeight

int	m_iFocusedEntryId = 0

bool	m_bIscrollActive

bool	m_bAnimateListAppearing

bool	m_bCreateList = false

Member Function Documentation

◆ AccessingHandlers()

void SCR_ListViewComponent.AccessingHandlers ( )

protected

Get reference to all needed component for handling.

◆ ActivateScrolling()

void SCR_ListViewComponent.ActivateScrolling ( bool activate )

Activate scrolling with input action.

◆ AnimateEntryOpacity()

void SCR_ListViewComponent.AnimateEntryOpacity	(	Widget	w,
		int	delay,
		float	animTime,
		float	opacityEnd,
		float	opacityStart = -1 )

protected

Setup opacity animation.

◆ CalculateLimit()

int SCR_ListViewComponent.CalculateLimit ( )

protected

Calulate entry limit number from list size and entry size.

◆ ChangeFocusWithoutAnimation()

void SCR_ListViewComponent.ChangeFocusWithoutAnimation ( Widget w )

protected

◆ CheckEntrySize()

void SCR_ListViewComponent.CheckEntrySize ( )

protected

Get size of widget entry used in list.

◆ ClearServerList()

void SCR_ListViewComponent.ClearServerList ( )

protected

Clear widgets from server list.

◆ CreateEntriesWidgets()

void SCR_ListViewComponent.CreateEntriesWidgets ( )

protected

Create server entries widget.

CheckEntrySize();

◆ CreateEntry()

void SCR_ListViewComponent.CreateEntry ( )

protected

◆ EntryFractionFromViewPos()

float SCR_ListViewComponent.EntryFractionFromViewPos	(	float	viewPos,
		float	scrollPos )

protected

Get fraction of whole entry in percents from positon in list view in percent based on scroll postion EntryFractionFromViewPos(1, ) = how much of entry is missing from bottom view

◆ FillEntry()

void SCR_ListViewComponent.FillEntry ( Widget w )

protected

Empty function for filling entries with data Override this to fill entries with data

◆ FirstAvailableEntry()

Widget SCR_ListViewComponent.FirstAvailableEntry ( )

Return first that is visible and enabled.

◆ FocusFirstAvailableEntry()

void SCR_ListViewComponent.FocusFirstAvailableEntry ( )

Find first available entry and focus it.

◆ GetEntryWidgets()

array< Widget > SCR_ListViewComponent.GetEntryWidgets ( )

◆ HandlerAttached()

override void SCR_ListViewComponent.HandlerAttached ( Widget w )

Implemented in SCR_ButtonListViewComponent.

◆ OnMenuDown()

void SCR_ListViewComponent.OnMenuDown ( )

protected

Scrolling with up/down buttons outside of list view Focus is focus rest widget

Check stepping over limit down

◆ OnMenuUp()

void SCR_ListViewComponent.OnMenuUp ( )

protected

Check stepping over limit up.

◆ OnUpdate()

override bool SCR_ListViewComponent.OnUpdate ( Widget w )

◆ OpacityAnimation()

void SCR_ListViewComponent.OpacityAnimation	(	Widget	w,
		int	time,
		float	opacityEnd )

protected

◆ PostCheck()

void SCR_ListViewComponent.PostCheck ( )

protected

◆ ScrollableEntriesCount()

float SCR_ListViewComponent.ScrollableEntriesCount ( )

Return how many entries can be scrolled.

◆ ScrollList()

void SCR_ListViewComponent.ScrollList	(	float	step,
		float	input )

protected

◆ ScrollMove()

float SCR_ListViewComponent.ScrollMove	(	float	step,
		float	inputMove )

protected

◆ ScrollOffsetMove()

void SCR_ListViewComponent.ScrollOffsetMove ( float scrollPos )

protected

Modify offset size to fake scrolling by scroll position.

◆ ScrollWheelMove()

void SCR_ListViewComponent.ScrollWheelMove ( )

protected

Scroll list based on input action.

◆ SetScrollbar()

void SCR_ListViewComponent.SetScrollbar ( SCR_ScrollBarComponent scrollbar )

◆ SetScrollbarVisible()

void SCR_ListViewComponent.SetScrollbarVisible ( bool visible )

◆ SetupEntryBehavior()

void SCR_ListViewComponent.SetupEntryBehavior ( Widget entry )

protected

Empty functions for setting up widget entry beavhior actions, callbacks, etc.

Override this to assign specific beavhior for each entry

Implemented in SCR_ButtonListViewComponent.

◆ StayOnLastEntry()

void SCR_ListViewComponent.StayOnLastEntry ( )

protected

Kepp focus on last entry on scroll.

◆ UpdateEntries()

void SCR_ListViewComponent.UpdateEntries ( bool animated = false )

Fill entries with data.

◆ UpdateScrollbar()

void SCR_ListViewComponent.UpdateScrollbar ( )

Member Data Documentation

◆ ENTRY_FIRST

const int SCR_ListViewComponent.ENTRY_FIRST = 0

static

◆ m_aEntryWidgets

ref array<Widget> SCR_ListViewComponent.m_aEntryWidgets = new array<Widget>

protected

◆ m_bAnimateListAppearing

bool SCR_ListViewComponent.m_bAnimateListAppearing

protected

◆ m_bAutomaticEntriesLimit

bool SCR_ListViewComponent.m_bAutomaticEntriesLimit

protected

◆ m_bCreateList

bool SCR_ListViewComponent.m_bCreateList = false

protected

◆ m_bIscrollActive

bool SCR_ListViewComponent.m_bIscrollActive

protected

◆ m_fAnimationAppearTime

float SCR_ListViewComponent.m_fAnimationAppearTime

protected

◆ m_fEntryWidgetHeight

float SCR_ListViewComponent.m_fEntryWidgetHeight

protected

◆ m_fScrollMove

float SCR_ListViewComponent.m_fScrollMove

protected

◆ m_fScrollPosition

float SCR_ListViewComponent.m_fScrollPosition = 0

protected

◆ m_iEntriesBottomPadding

int SCR_ListViewComponent.m_iEntriesBottomPadding

protected

◆ m_iEntriesCount

float SCR_ListViewComponent.m_iEntriesCount = 0

protected

◆ m_iEntriesLimit

int SCR_ListViewComponent.m_iEntriesLimit

protected

◆ m_iFocusedEntryId

int SCR_ListViewComponent.m_iFocusedEntryId = 0

protected

◆ m_iLastScrollPosition

float SCR_ListViewComponent.m_iLastScrollPosition = 0

protected

◆ m_Scrollbar

SCR_ScrollBarComponent SCR_ListViewComponent.m_Scrollbar

protected

◆ m_sEntry

ResourceName SCR_ListViewComponent.m_sEntry

protected

◆ m_sScrollAction

string SCR_ListViewComponent.m_sScrollAction

protected

◆ m_wFocusRest

Widget SCR_ListViewComponent.m_wFocusRest

protected

◆ m_wRoot

Widget SCR_ListViewComponent.m_wRoot

◆ m_wSizeScrollOffset

SizeLayoutWidget SCR_ListViewComponent.m_wSizeScrollOffset

protected

◆ m_wVerticalList

Widget SCR_ListViewComponent.m_wVerticalList

protected

◆ WIDGET_FOCUS_REST

const string SCR_ListViewComponent.WIDGET_FOCUS_REST = "BtnFocusRest"

static

◆ WIDGET_SIZE_SCROLL_OFFSET

const string SCR_ListViewComponent.WIDGET_SIZE_SCROLL_OFFSET = "SizeScrollOffset"

static

◆ WIDGET_VERTICAL_LIST

const string SCR_ListViewComponent.WIDGET_VERTICAL_LIST = "VList"

static

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

Game/UI/Components/WidgetLibrary/SCR_ListView/SCR_ListViewComponent.c

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Member Function Documentation

◆ AccessingHandlers()

◆ ActivateScrolling()

◆ AnimateEntryOpacity()

◆ CalculateLimit()

◆ ChangeFocusWithoutAnimation()

◆ CheckEntrySize()

◆ ClearServerList()

◆ CreateEntriesWidgets()

◆ CreateEntry()

◆ EntryFractionFromViewPos()

◆ FillEntry()

◆ FirstAvailableEntry()

◆ FocusFirstAvailableEntry()

◆ GetEntryWidgets()

◆ HandlerAttached()

◆ OnMenuDown()

◆ OnMenuUp()

◆ OnUpdate()

◆ OpacityAnimation()

◆ PostCheck()

◆ ScrollableEntriesCount()

◆ ScrollList()

◆ ScrollMove()

◆ ScrollOffsetMove()

◆ ScrollWheelMove()

◆ SetScrollbar()

◆ SetScrollbarVisible()

◆ SetupEntryBehavior()

◆ StayOnLastEntry()

◆ UpdateEntries()

◆ UpdateScrollbar()

Member Data Documentation

◆ ENTRY_FIRST

◆ m_aEntryWidgets

◆ m_bAnimateListAppearing

◆ m_bAutomaticEntriesLimit

◆ m_bCreateList

◆ m_bIscrollActive

◆ m_fAnimationAppearTime

◆ m_fEntryWidgetHeight

◆ m_fScrollMove

◆ m_fScrollPosition

◆ m_iEntriesBottomPadding

◆ m_iEntriesCount

◆ m_iEntriesLimit

◆ m_iFocusedEntryId

◆ m_iLastScrollPosition

◆ m_Scrollbar

◆ m_sEntry

◆ m_sScrollAction

◆ m_wFocusRest

◆ m_wRoot

◆ m_wSizeScrollOffset

◆ m_wVerticalList

◆ WIDGET_FOCUS_REST

◆ WIDGET_SIZE_SCROLL_OFFSET

◆ WIDGET_VERTICAL_LIST