SCR_WidgetListEntryCheckList Interface Reference

Inheritance diagram for SCR_WidgetListEntryCheckList:

Public Member Functions
override void	CreateWidget (Widget parent)
	Removed setting up of m_ChangeableComponent as it's not used for this case.
void	ToggleCheckbox (notnull SCR_ListBoxElementComponent checkBox, bool enabled)
SCR_ListBoxElementComponent	AddElement (SCR_LocalizedProperty property, bool enabled)
	Add new element and create it in the list.
array< string >	EnabledCheckListPropertyNames ()
int	CheckboxesCount ()
SCR_ListBoxElementComponent	FindCheckboxByPropertyName (string propertyName)
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
void	OnCheckboxClick (SCR_ModularButtonComponent button)
	Handle toggling in script as checkbox can't be interacted without script.
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
ResourceName	m_sElementPath
ref array< ref SCR_LocalizedProperty >	m_aProperties = {}
ref array< ref SCR_ListBoxElementComponent >	m_aCheckboxes = {}
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"

Member Function Documentation

AddElement()

SCR_ListBoxElementComponent SCR_WidgetListEntryCheckList.AddElement	(	SCR_LocalizedProperty	property,
		bool	enabled
	)

Add new element and create it in the list.

CheckboxesCount()

int SCR_WidgetListEntryCheckList.CheckboxesCount

(

)

CreateWidget()

override void SCR_WidgetListEntryCheckList.CreateWidget

(

Widget

parent

)

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

Implements SCR_WidgetListEntry.

EnabledCheckListPropertyNames()

array< string > SCR_WidgetListEntryCheckList.EnabledCheckListPropertyNames

(

)

FindCheckboxByPropertyName()

SCR_ListBoxElementComponent SCR_WidgetListEntryCheckList.FindCheckboxByPropertyName

(

string

propertyName

)

OnCheckboxClick()

void SCR_WidgetListEntryCheckList.OnCheckboxClick ( SCR_ModularButtonComponent  button )

protected

Handle toggling in script as checkbox can't be interacted without script.

ToggleCheckbox()

void SCR_WidgetListEntryCheckList.ToggleCheckbox	(	notnull SCR_ListBoxElementComponent	checkBox,
		bool	enabled
	)

Member Data Documentation

m_aCheckboxes

ref array<ref SCR_ListBoxElementComponent> SCR_WidgetListEntryCheckList.m_aCheckboxes = {}

protected

m_aProperties

ref array<ref SCR_LocalizedProperty> SCR_WidgetListEntryCheckList.m_aProperties = {}

protected

m_sElementPath

ResourceName SCR_WidgetListEntryCheckList.m_sElementPath

protected

---

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

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