SCR_WidgetListEntrySelectionList Interface Reference

Can hold multiple entries, setup and read them. More...

Inheritance diagram for SCR_WidgetListEntrySelectionList:

Public Member Functions
override void	CreateWidget (Widget parent)
	Removed setting up of m_ChangeableComponent as it's not used for this case.
void	AddElement (notnull SCR_WidgetListEntry entry)
void	RemoveElementByName (string propertyName)
void	RemoveElementByWidget (Widget widget)
void	GetEntries (out array< SCR_WidgetListEntry > entries)
array< string >	GetElementValues ()
ScriptInvokerVoid	GetOnAddingButtonElement ()
ScriptInvokerWidget	GetOnAddElement ()
SCR_WidgetListEntry	GetElement ()
Public Member Functions inherited from SCR_WidgetListEntry
void	CreateWidget (Widget parent)
string	ValueAsString ()
	Return value from widget in string format.
void	SetValue (string str)
bool	CheckValidity ()
	Default validity for majority of inputs will be true.
void	SetInteractive (bool interactive)
	Can value be interacted - set handler enabled.
ResourceName	GetEntryLayout ()
void	SetEntryLayout (ResourceName layout)
string	GetLabel ()
void	SetLabel (string label)
string	GetPropertyName ()
void	SetPropertyName (string propertyName)
string	GetGroupTag ()
void	SetGroupTag (string tag)
EJsonApiStructValueType	GetType ()
Widget	GetEntryRoot ()
bool	IsInputValid ()
bool	GetVisible ()
void	SetVisible (bool show)

Protected Member Functions
override void	SetupHandlers ()
	Empty function to override to assing custom handlers.
void	FindElements (array< string > elementNames)
	Search for elements with given names.
void	OnClickAddingButton ()
Protected Member Functions inherited from SCR_WidgetListEntry
void	SetupHandlers ()
	Empty function to override to assing custom handlers.
bool	CanSkip ()
	Can skip return true if input is empty and value is not required.

Protected Attributes
ref SCR_WidgetListEntry	m_Element
ResourceName	m_sAddingElementPath
string	m_ElementType
ref array< ref SCR_WidgetListEntry >	m_aEntries
ref SCR_ModularButtonComponent	m_AddingButton
ref ScriptInvokerVoid	m_OnClickAddingButton
ref ScriptInvokerWidget	m_OnAddElement
Protected Attributes inherited from SCR_WidgetListEntry
ResourceName	m_sEntryLayout
bool	m_bShow
string	m_sLabel
string	m_sPropertyName
string	m_sGroupTag
string	m_sDefaultValue
bool	m_bRequired
bool	m_bInteractive
SCR_ChangeableComponentBase	m_ChangeableComponent
EJsonApiStructValueType	m_iType
string	m_sClassTag
Widget	m_EntryRoot
bool	m_bValidInput = true

Additional Inherited Members
Static Public Member Functions inherited from SCR_WidgetListEntry
static SCR_ConfigListEntries	GetEntriesDefinitions (ResourceName presetsResourceName)
Static Public Attributes inherited from SCR_WidgetListEntry
const string	INVALID_VALUE = "-invalid-"
Static Protected Attributes inherited from SCR_WidgetListEntry
const ResourceName	ENTRY_DEFINITIONS = "{A6EFD45A3A38965C}Configs/JsonConfigList/JsonConfigListDefinition.conf"

Detailed Description

Can hold multiple entries, setup and read them.

Member Function Documentation

AddElement()

void SCR_WidgetListEntrySelectionList.AddElement

(

notnull SCR_WidgetListEntry

entry

)

CreateWidget()

override void SCR_WidgetListEntrySelectionList.CreateWidget

(

Widget

parent

)

Removed setting up of m_ChangeableComponent as it's not used for this case.

Implements SCR_WidgetListEntry.

FindElements()

void SCR_WidgetListEntrySelectionList.FindElements ( array< string >  elementNames )

protected

Search for elements with given names.

GetElement()

SCR_WidgetListEntry SCR_WidgetListEntrySelectionList.GetElement

(

)

GetElementValues()

array< string > SCR_WidgetListEntrySelectionList.GetElementValues

(

)

GetEntries()

void SCR_WidgetListEntrySelectionList.GetEntries

(

out array< SCR_WidgetListEntry >

entries

)

GetOnAddElement()

ScriptInvokerWidget SCR_WidgetListEntrySelectionList.GetOnAddElement

(

)

GetOnAddingButtonElement()

ScriptInvokerVoid SCR_WidgetListEntrySelectionList.GetOnAddingButtonElement

(

)

OnClickAddingButton()

void SCR_WidgetListEntrySelectionList.OnClickAddingButton ( )

protected

RemoveElementByName()

void SCR_WidgetListEntrySelectionList.RemoveElementByName

(

string

propertyName

)

RemoveElementByWidget()

void SCR_WidgetListEntrySelectionList.RemoveElementByWidget

(

Widget

widget

)

SetupHandlers()

override void SCR_WidgetListEntrySelectionList.SetupHandlers ( )

protected

Empty function to override to assing custom handlers.

Implements SCR_WidgetListEntry.

Member Data Documentation

m_AddingButton

ref SCR_ModularButtonComponent SCR_WidgetListEntrySelectionList.m_AddingButton

protected

m_aEntries

ref array<ref SCR_WidgetListEntry> SCR_WidgetListEntrySelectionList.m_aEntries

protected

m_Element

ref SCR_WidgetListEntry SCR_WidgetListEntrySelectionList.m_Element

protected

m_ElementType

string SCR_WidgetListEntrySelectionList.m_ElementType

protected

m_OnAddElement

ref ScriptInvokerWidget SCR_WidgetListEntrySelectionList.m_OnAddElement

protected

m_OnClickAddingButton

ref ScriptInvokerVoid SCR_WidgetListEntrySelectionList.m_OnClickAddingButton

protected

m_sAddingElementPath

ResourceName SCR_WidgetListEntrySelectionList.m_sAddingElementPath

protected

---

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

• Game/UI/Menu/ConfigurableWidgetEntries/SCR_WidgetListEntrySelectionList.c