SCR_WidgetListEntry Interface Reference

Configurable class for widget. More...

Inheritance diagram for SCR_WidgetListEntry:

Public Member Functions
void	CreateWidget (Widget parent)
void	RemoveWidget ()
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)

Static Public Member Functions
static SCR_ConfigListEntries	GetEntriesDefinitions (ResourceName presetsResourceName)

Static Public Attributes
const string	INVALID_VALUE = "-invalid-"

Protected Member Functions
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_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

Static Protected Attributes
const ResourceName	ENTRY_DEFINITIONS = "{A6EFD45A3A38965C}Configs/JsonConfigList/JsonConfigListDefinition.conf"

Detailed Description

Configurable class for widget.

Member Function Documentation

CanSkip()

bool SCR_WidgetListEntry.CanSkip ( )

protected

Can skip return true if input is empty and value is not required.

CheckValidity()

bool SCR_WidgetListEntry.CheckValidity

(

)

Default validity for majority of inputs will be true.

Implemented in SCR_WidgetListEntryEditBox, and SCR_WidgetListEntryEditBoxIP.

CreateWidget()

void SCR_WidgetListEntry.CreateWidget

(

Widget

parent

)

Implemented in SCR_WidgetListEntryCheckList, SCR_WidgetListEntryLabel, SCR_WidgetListEntryMessage, SCR_WidgetListEntryPublishImages, and SCR_WidgetListEntrySelectionList.

GetEntriesDefinitions()

static SCR_ConfigListEntries SCR_WidgetListEntry.GetEntriesDefinitions ( ResourceName presetsResourceName )

static

GetEntryLayout()

ResourceName SCR_WidgetListEntry.GetEntryLayout

(

)

GetEntryRoot()

Widget SCR_WidgetListEntry.GetEntryRoot

(

)

GetGroupTag()

string SCR_WidgetListEntry.GetGroupTag

(

)

GetLabel()

string SCR_WidgetListEntry.GetLabel

(

)

GetPropertyName()

string SCR_WidgetListEntry.GetPropertyName

(

)

GetType()

EJsonApiStructValueType SCR_WidgetListEntry.GetType

(

)

GetVisible()

bool SCR_WidgetListEntry.GetVisible

(

)

IsInputValid()

bool SCR_WidgetListEntry.IsInputValid

(

)

RemoveWidget()

void SCR_WidgetListEntry.RemoveWidget

(

)

Implemented in SCR_WidgetListEntryEditBox.

SetEntryLayout()

void SCR_WidgetListEntry.SetEntryLayout

(

ResourceName

layout

)

SetGroupTag()

void SCR_WidgetListEntry.SetGroupTag

(

string

tag

)

SetInteractive()

void SCR_WidgetListEntry.SetInteractive

(

bool

interactive

)

Can value be interacted - set handler enabled.

SetLabel()

void SCR_WidgetListEntry.SetLabel

(

string

label

)

SetPropertyName()

void SCR_WidgetListEntry.SetPropertyName

(

string

propertyName

)

SetupHandlers()

void SCR_WidgetListEntry.SetupHandlers ( )

protected

Empty function to override to assing custom handlers.

Implemented in SCR_WidgetListEntryBoolSpinBox, SCR_WidgetListEntryCheckBox, SCR_WidgetListEntryEditBox, SCR_WidgetListEntryEditBoxIP, SCR_WidgetListEntryPublishImages, SCR_WidgetListEntryResourcePicker, SCR_WidgetListEntrySelection, SCR_WidgetListEntrySelectionList, SCR_WidgetListEntrySlider, and SCR_WidgetListEntrySpinBox.

SetValue()

void SCR_WidgetListEntry.SetValue

(

string

str

)

Implemented in SCR_WidgetListEntryBoolSpinBox, SCR_WidgetListEntryCheckBox, SCR_WidgetListEntryEditBox, SCR_WidgetListEntryMessage, SCR_WidgetListEntryResourcePicker, SCR_WidgetListEntrySlider, and SCR_WidgetListEntrySpinBox.

SetVisible()

void SCR_WidgetListEntry.SetVisible

(

bool

show

)

ValueAsString()

string SCR_WidgetListEntry.ValueAsString

(

)

Return value from widget in string format.

Implemented in SCR_WidgetListEntryCheckBox, SCR_WidgetListEntryEditBox, SCR_WidgetListEntryMessage, SCR_WidgetListEntryResourcePicker, SCR_WidgetListEntrySelection, and SCR_WidgetListEntrySlider.

Member Data Documentation

ENTRY_DEFINITIONS

const ResourceName SCR_WidgetListEntry.ENTRY_DEFINITIONS = "{A6EFD45A3A38965C}Configs/JsonConfigList/JsonConfigListDefinition.conf"

staticprotected

INVALID_VALUE

const string SCR_WidgetListEntry.INVALID_VALUE = "-invalid-"

static

m_bInteractive

bool SCR_WidgetListEntry.m_bInteractive

protected

m_bRequired

bool SCR_WidgetListEntry.m_bRequired

protected

m_bShow

bool SCR_WidgetListEntry.m_bShow

protected

m_bValidInput

bool SCR_WidgetListEntry.m_bValidInput = true

protected

m_ChangeableComponent

SCR_ChangeableComponentBase SCR_WidgetListEntry.m_ChangeableComponent

protected

m_EntryRoot

Widget SCR_WidgetListEntry.m_EntryRoot

protected

m_iType

EJsonApiStructValueType SCR_WidgetListEntry.m_iType

protected

m_sClassTag

string SCR_WidgetListEntry.m_sClassTag

protected

m_sDefaultValue

string SCR_WidgetListEntry.m_sDefaultValue

protected

m_sEntryLayout

ResourceName SCR_WidgetListEntry.m_sEntryLayout

protected

m_sGroupTag

string SCR_WidgetListEntry.m_sGroupTag

protected

m_sLabel

string SCR_WidgetListEntry.m_sLabel

protected

m_sPropertyName

string SCR_WidgetListEntry.m_sPropertyName

protected

---

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

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