SCR_WidgetListEntrySelection Interface Reference

Configurable widget list entry list selection. More...

Inheritance diagram for SCR_WidgetListEntrySelection:

Public Member Functions
override string	ValueAsString ()
	Return value from widget in string format.
int	ValueId ()
	Get selected value as id.
void	SelectOption (int id)
SCR_LocalizedProperty	GetSelectedOption ()
	Return current selected option as full localized property.
void	SetOptions (array< ref SCR_LocalizedProperty > options)
	Fill list with options.
SCR_SelectionWidgetComponent	GetSelectionComponent ()
void	GetOptions (out array< ref SCR_LocalizedProperty > options)
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 ()

Protected Member Functions
override void	SetupHandlers ()
	Empty function to override to assing custom handlers.
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 array< ref SCR_LocalizedProperty >	m_aOptions
SCR_SelectionWidgetComponent	m_Selection
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 Attributes inherited from SCR_WidgetListEntry
const string	INVALID_VALUE = "-invalid-"

Detailed Description

Configurable widget list entry list selection.

Member Function Documentation

GetOptions()

void SCR_WidgetListEntrySelection.GetOptions

(

out array< ref SCR_LocalizedProperty >

options

)

GetSelectedOption()

SCR_LocalizedProperty SCR_WidgetListEntrySelection.GetSelectedOption

(

)

Return current selected option as full localized property.

GetSelectionComponent()

SCR_SelectionWidgetComponent SCR_WidgetListEntrySelection.GetSelectionComponent

(

)

SelectOption()

void SCR_WidgetListEntrySelection.SelectOption

(

int

id

)

SetOptions()

void SCR_WidgetListEntrySelection.SetOptions

(

array< ref SCR_LocalizedProperty >

options

)

Fill list with options.

SetupHandlers()

override void SCR_WidgetListEntrySelection.SetupHandlers ( )

protected

Empty function to override to assing custom handlers.

Implements SCR_WidgetListEntry.

Implemented in SCR_WidgetListEntrySpinBox, and SCR_WidgetListEntryBoolSpinBox.

ValueAsString()

override string SCR_WidgetListEntrySelection.ValueAsString

(

)

Return value from widget in string format.

Implements SCR_WidgetListEntry.

ValueId()

int SCR_WidgetListEntrySelection.ValueId

(

)

Get selected value as id.

Member Data Documentation

m_aOptions

ref array<ref SCR_LocalizedProperty> SCR_WidgetListEntrySelection.m_aOptions

protected

m_Selection

SCR_SelectionWidgetComponent SCR_WidgetListEntrySelection.m_Selection

protected

---

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

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