SCR_GalleryComponent Interface Reference

Inheritance diagram for SCR_GalleryComponent:

Public Member Functions
override void	HandlerAttached (Widget w)
void	ShowPagingButtons (bool animate=true)
void	OnItemFocused (Widget w)
void	OnCustomLeft ()
void	OnCustomRight ()
void	OnNavigationLeft ()
void	OnNavigationRight ()
void	SetFocusedItem (int index, bool force=false)
int	GetWidgets (out array< Widget > widgets)
Widget	AddItem ()
int	AddItem (Widget widget)
void	ClearAll ()
void	RemoveItem (int item)
void	SetCurrentItem (int i, bool animate=false)

Static Public Member Functions
static SCR_GalleryComponent	GetGalleryComponent (string name, Widget parent, bool searchAllChildren=true)
	Static method to easily find component by providing name and parent.

Protected Member Functions
void	OnInputDeviceIsGamepad (bool isGamepad)
void	UpdatePagingButtons ()
void	SetupHints (int count, bool animate=true)
void	CreateWidgets (int count)
Widget	CreateWidget ()
void	SetAnimationRate ()
void	OnNextItem ()
void	OnPreviousItem ()
void	ShowTiles (int startingIndex, bool animate=true)

Protected Attributes
int	m_iInitialItemCount
int	m_iSelectedItem
int	m_iCountShownItems
bool	m_bMovePerPage
float	m_fSpacing
ResourceName	m_sItemLayout
string	m_sActionLeft
string	m_sActionRight
bool	m_bShowPagingHints
bool	m_bCycleMode
float	m_fAnimationTime
bool	m_bShowNavigationArrows
string	m_sHintName
string	m_sContentName
ref array< Widget >	m_aWidgets = {}
SCR_SelectionHintComponent	m_Hint
SCR_PagingButtonComponent	m_PagingLeft
SCR_PagingButtonComponent	m_PagingRight
Widget	m_wContentRoot
Widget	m_wRoot
float	m_fAnimationRate = SCR_WLibComponentBase.START_ANIMATION_RATE

Member Function Documentation

AddItem() [1/2]

Widget SCR_GalleryComponent.AddItem

(

)

AddItem() [2/2]

int SCR_GalleryComponent.AddItem

(

Widget

widget

)

ClearAll()

void SCR_GalleryComponent.ClearAll

(

)

Implemented in SCR_LoadoutGallery.

CreateWidget()

Widget SCR_GalleryComponent.CreateWidget ( )

protected

CreateWidgets()

void SCR_GalleryComponent.CreateWidgets ( int  count )

protected

GetGalleryComponent()

static SCR_GalleryComponent SCR_GalleryComponent.GetGalleryComponent ( string  name, Widget  parent, bool  searchAllChildren = true  )

static

Static method to easily find component by providing name and parent.

Searching all children will go through whole hierarchy, instead of immediate chidren

GetWidgets()

int SCR_GalleryComponent.GetWidgets

(

out array< Widget >

widgets

)

HandlerAttached()

override void SCR_GalleryComponent.HandlerAttached

(

Widget

w

)

Implemented in SCR_LoadoutGallery.

OnCustomLeft()

void SCR_GalleryComponent.OnCustomLeft

(

)

OnCustomRight()

void SCR_GalleryComponent.OnCustomRight

(

)

OnInputDeviceIsGamepad()

void SCR_GalleryComponent.OnInputDeviceIsGamepad ( bool  isGamepad )

protected

OnItemFocused()

void SCR_GalleryComponent.OnItemFocused

(

Widget

w

)

OnNavigationLeft()

void SCR_GalleryComponent.OnNavigationLeft

(

)

OnNavigationRight()

void SCR_GalleryComponent.OnNavigationRight

(

)

OnNextItem()

void SCR_GalleryComponent.OnNextItem ( )

protected

OnPreviousItem()

void SCR_GalleryComponent.OnPreviousItem ( )

protected

RemoveItem()

void SCR_GalleryComponent.RemoveItem

(

int

item

)

SetAnimationRate()

void SCR_GalleryComponent.SetAnimationRate ( )

protected

SetCurrentItem()

void SCR_GalleryComponent.SetCurrentItem	(	int	i,
		bool	animate = false
	)

SetFocusedItem()

void SCR_GalleryComponent.SetFocusedItem	(	int	index,
		bool	force = false
	)

SetupHints()

void SCR_GalleryComponent.SetupHints ( int  count, bool  animate = true  )

protected

ShowPagingButtons()

void SCR_GalleryComponent.ShowPagingButtons

(

bool

animate = true

)

Implemented in SCR_LoadoutGallery.

ShowTiles()

void SCR_GalleryComponent.ShowTiles ( int  startingIndex, bool  animate = true  )

protected

UpdatePagingButtons()

void SCR_GalleryComponent.UpdatePagingButtons ( )

protected

Member Data Documentation

m_aWidgets

ref array<Widget> SCR_GalleryComponent.m_aWidgets = {}

protected

m_bCycleMode

bool SCR_GalleryComponent.m_bCycleMode

protected

m_bMovePerPage

bool SCR_GalleryComponent.m_bMovePerPage

protected

m_bShowNavigationArrows

bool SCR_GalleryComponent.m_bShowNavigationArrows

protected

m_bShowPagingHints

bool SCR_GalleryComponent.m_bShowPagingHints

protected

m_fAnimationRate

float SCR_GalleryComponent.m_fAnimationRate = SCR_WLibComponentBase.START_ANIMATION_RATE

protected

m_fAnimationTime

float SCR_GalleryComponent.m_fAnimationTime

protected

m_fSpacing

float SCR_GalleryComponent.m_fSpacing

protected

m_Hint

SCR_SelectionHintComponent SCR_GalleryComponent.m_Hint

protected

m_iCountShownItems

int SCR_GalleryComponent.m_iCountShownItems

protected

m_iInitialItemCount

int SCR_GalleryComponent.m_iInitialItemCount

protected

m_iSelectedItem

int SCR_GalleryComponent.m_iSelectedItem

protected

m_PagingLeft

SCR_PagingButtonComponent SCR_GalleryComponent.m_PagingLeft

protected

m_PagingRight

SCR_PagingButtonComponent SCR_GalleryComponent.m_PagingRight

protected

m_sActionLeft

string SCR_GalleryComponent.m_sActionLeft

protected

m_sActionRight

string SCR_GalleryComponent.m_sActionRight

protected

m_sContentName

string SCR_GalleryComponent.m_sContentName

protected

m_sHintName

string SCR_GalleryComponent.m_sHintName

protected

m_sItemLayout

ResourceName SCR_GalleryComponent.m_sItemLayout

protected

m_wContentRoot

Widget SCR_GalleryComponent.m_wContentRoot

protected

m_wRoot

Widget SCR_GalleryComponent.m_wRoot

protected

---

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

• Game/UI/Components/WidgetLibrary/GalleryView/SCR_GalleryComponent.c