Arma Reforger Script API
Loading...
Searching...
No Matches
SCR_WidgetListEntryEditBox Interface Reference

Configurable widget list entry for various value that can be typed - numbers, strings, references. More...

Inheritance diagram for SCR_WidgetListEntryEditBox:
SCR_WidgetListEntry SCR_WidgetListEntryEditBoxIP

Public Member Functions

override void RemoveWidget ()
 
override string ValueAsString ()
 Return value from widget in string format.
 
override void SetValue (string str)
 
override bool CheckValidity ()
 Default validity for majority of inputs will be true.
 
void CheckEditBoxValidity (SCR_EditBoxComponent editBox, string value)
 Check if input is right, otherwise show warning.
 
void ClearInvalidInput ()
 
SCR_EditBoxComponent GetEditBoxComponent ()
 
SCR_WidgetEditFormat GetFormatCheck ()
 
void SetWarningText (string warning)
 
- Public Member Functions inherited from SCR_WidgetListEntry
void CreateWidget (Widget parent)
 
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 SetCharLists ()
 
void OnEditBoxTextChange (string text)
 
void UpdateEditBoxText ()
 
void OnEditModeLeave (string text)
 
void InvokeInvalidInput ()
 
void OnInvalidInput ()
 
- Protected Member Functions inherited from SCR_WidgetListEntry
bool CanSkip ()
 Can skip return true if input is empty and value is not required.
 

Protected Attributes

EJsonApiStructValueType m_iEditType
 
int m_CharLimit
 
int m_fClearErrorTimes
 
ref SCR_WidgetEditFormat m_FormatCheck
 
string m_sPlaceholderText
 
bool m_bUseFormatWarning
 
string m_sWarningText
 
string m_sObfuscation
 
string m_sCharBlackList
 
bool m_bShowWriteIcon
 
float m_fCustomHeight
 
SCR_EditBoxComponent m_EditBox
 
EditBoxFilterComponent m_Filter
 
string m_sCurrentValue
 
- 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

Configurable widget list entry for various value that can be typed - numbers, strings, references.

Member Function Documentation

◆ CheckEditBoxValidity()

void SCR_WidgetListEntryEditBox.CheckEditBoxValidity ( SCR_EditBoxComponent editBox,
string value )

Check if input is right, otherwise show warning.

◆ CheckValidity()

override bool SCR_WidgetListEntryEditBox.CheckValidity ( )

Default validity for majority of inputs will be true.

Implements SCR_WidgetListEntry.

Implemented in SCR_WidgetListEntryEditBoxIP.

◆ ClearInvalidInput()

void SCR_WidgetListEntryEditBox.ClearInvalidInput ( )

◆ GetEditBoxComponent()

SCR_EditBoxComponent SCR_WidgetListEntryEditBox.GetEditBoxComponent ( )

◆ GetFormatCheck()

SCR_WidgetEditFormat SCR_WidgetListEntryEditBox.GetFormatCheck ( )

◆ InvokeInvalidInput()

void SCR_WidgetListEntryEditBox.InvokeInvalidInput ( )
protected

◆ OnEditBoxTextChange()

void SCR_WidgetListEntryEditBox.OnEditBoxTextChange ( string text)
protected

◆ OnEditModeLeave()

void SCR_WidgetListEntryEditBox.OnEditModeLeave ( string text)
protected

◆ OnInvalidInput()

void SCR_WidgetListEntryEditBox.OnInvalidInput ( )
protected

◆ RemoveWidget()

override void SCR_WidgetListEntryEditBox.RemoveWidget ( )

Implements SCR_WidgetListEntry.

◆ SetCharLists()

void SCR_WidgetListEntryEditBox.SetCharLists ( )
protected

◆ SetupHandlers()

override void SCR_WidgetListEntryEditBox.SetupHandlers ( )
protected

Empty function to override to assing custom handlers.

Implements SCR_WidgetListEntry.

Implemented in SCR_WidgetListEntryEditBoxIP.

◆ SetValue()

override void SCR_WidgetListEntryEditBox.SetValue ( string str)

Implements SCR_WidgetListEntry.

◆ SetWarningText()

void SCR_WidgetListEntryEditBox.SetWarningText ( string warning)

◆ UpdateEditBoxText()

void SCR_WidgetListEntryEditBox.UpdateEditBoxText ( )
protected

◆ ValueAsString()

override string SCR_WidgetListEntryEditBox.ValueAsString ( )

Return value from widget in string format.

Implements SCR_WidgetListEntry.

Member Data Documentation

◆ m_bShowWriteIcon

bool SCR_WidgetListEntryEditBox.m_bShowWriteIcon
protected

◆ m_bUseFormatWarning

bool SCR_WidgetListEntryEditBox.m_bUseFormatWarning
protected

◆ m_CharLimit

int SCR_WidgetListEntryEditBox.m_CharLimit
protected

◆ m_EditBox

SCR_EditBoxComponent SCR_WidgetListEntryEditBox.m_EditBox
protected

◆ m_fClearErrorTimes

int SCR_WidgetListEntryEditBox.m_fClearErrorTimes
protected

◆ m_fCustomHeight

float SCR_WidgetListEntryEditBox.m_fCustomHeight
protected

◆ m_Filter

EditBoxFilterComponent SCR_WidgetListEntryEditBox.m_Filter
protected

◆ m_FormatCheck

ref SCR_WidgetEditFormat SCR_WidgetListEntryEditBox.m_FormatCheck
protected

◆ m_iEditType

EJsonApiStructValueType SCR_WidgetListEntryEditBox.m_iEditType
protected

◆ m_sCharBlackList

string SCR_WidgetListEntryEditBox.m_sCharBlackList
protected

◆ m_sCurrentValue

string SCR_WidgetListEntryEditBox.m_sCurrentValue
protected

◆ m_sObfuscation

string SCR_WidgetListEntryEditBox.m_sObfuscation
protected

◆ m_sPlaceholderText

string SCR_WidgetListEntryEditBox.m_sPlaceholderText
protected

◆ m_sWarningText

string SCR_WidgetListEntryEditBox.m_sWarningText
protected

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