Inheritance diagram for SCR_EditBoxComponent:

[legend]

Public Member Functions
override void	HandlerAttached (Widget w)

override void	HandlerDeattached (Widget w)

override bool	OnFocus (Widget w, int x, int y)

void	OnValueChanged ()

void	OnHandlerFocus ()

void	OnHandlerFocusLost ()

void	OnInvalidInput ()

void	ClearInvalidInput ()

void	ChangeOverlayColor (Color color)

void	ResetOverlayColor ()

void	SetPlaceholderText (string str)

void	ActivateWriteMode (bool refocus=false)
	Set write mode of editbox handler.

void	ShowHint (bool show)

void	ShowWriteIcon (bool show)

void	UpdateInteractionState (bool forceDisabled)

void	ClearInteractionState ()

void	SetValue (string value)
	User API.

string	GetValue ()

string	GetPlaceHolderText ()

Widget	GetEditBoxWidget ()

bool	IsValidInput ()

SCR_WidgetHintComponent	GetHint ()

bool	IsInWriteMode ()

SCR_EventHandlerComponent	GetEVHComponent ()

void	ConfirmValue (string value)
	Set string value to editbox and confirm.

Public Member Functions inherited from SCR_ChangeableComponentBase
override void	HandlerAttached (Widget w)

override bool	OnFocus (Widget w, int x, int y)

override bool	OnFocusLost (Widget w, int x, int y)

override bool	OnMouseEnter (Widget w, int x, int y)

override bool	OnMouseLeave (Widget w, Widget enterW, int x, int y)

TextWidget	GetLabel ()

void	SetLabel (string label)

void	UseLabel (bool use)

bool	IsUsingLabel ()

Widget	GetLabelWidget ()
	If label is not used, label widget might not exist at all!

void	SetSizeWithLabel (float size)

void	SetSizeWithoutLabel (float size)

Public Member Functions inherited from SCR_WLibComponentBase
override void	HandlerAttached (Widget w)

override bool	OnClick (Widget w, int x, int y, int button)

override bool	OnMouseEnter (Widget w, int x, int y)

override bool	OnFocus (Widget w, int x, int y)

void	SetHoverSound (string soundHover)

void	SetClickedSound (string soundClicked)

string	GetHoverSound ()

string	GetClickedSound ()

void	SetEnabled (bool enabled, bool animate=true)

void	SetVisible (bool visible, bool animate=true)

bool	IsEnabled ()

void	SetMouseOverToFocus (bool mouseOverToFocus)

void	SetDisabledOpacity (float newDisabledOpacity)

Public Member Functions inherited from SCR_ScriptedWidgetComponent
override void	HandlerAttached (Widget w)

override bool	OnClick (Widget w, int x, int y, int button)

Widget	GetRootWidget ()

bool	IsVisible ()

Static Public Member Functions
static SCR_EditBoxComponent	GetEditBoxComponent (string name, Widget parent, bool searchAllChildren=true)
	Static method to easily find component by providing name and parent.

Static Public Member Functions inherited from SCR_WLibComponentBase
static bool	SetTexture (ImageWidget widget, ResourceName texture, string image="")

Static Public Member Functions inherited from SCR_ScriptedWidgetComponent
static SCR_ScriptedWidgetComponent	GetComponent (TypeName componentType, string name, Widget parent, bool searchAllChildren=true)
	Base method for component lookup through the widget library.

Public Attributes
Widget	m_wEditBox

Widget	m_wColorOverlay

Widget	m_wEditBackground

Widget	m_wWarningIcon

Widget	m_wHorizontalLayout

Widget	m_wWriteIconScale

ImageWidget	m_wImgWriteIcon

ref ScriptInvoker	m_OnConfirm = new ScriptInvoker()

ref ScriptInvoker	m_OnFocusChangedEditBox = new ScriptInvoker()

ref ScriptInvokerVoid	m_OnWriteModeEnter = new ScriptInvokerVoid()

ref ScriptInvokerVoid	m_OnCancel = new ScriptInvokerVoid()

ref ScriptInvokerString	m_OnWriteModeLeave = new ScriptInvokerString()

ref ScriptInvokerString	m_OnTextChange = new ScriptInvokerString()

Public Attributes inherited from SCR_ChangeableComponentBase
ref ScriptInvoker	m_OnChanged = new ScriptInvoker()

Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Protected Member Functions
void	OnCancel ()

void	OnConfirm (Widget w)

void	OnInternalButtonClicked ()

string	GetEditBoxText ()

void	SetEditBoxText (string text)

string	GetPlaceholderText ()

void	UpdateBackgroundColor ()

Protected Member Functions inherited from SCR_ChangeableComponentBase
void	SetupLabel ()

void	ClearLabel ()

Protected Member Functions inherited from SCR_WLibComponentBase
void	OnEnabled (bool animate)

void	OnDisabled (bool animate)

bool	IsChildWidget (Widget parent, Widget child)

void	SetAnimationRate ()

void	PlaySound (string sound)

Protected Attributes
float	m_fColorsAnimationTime

bool	m_bShowWriteIcon

bool	m_bShowInvalidInputWarning

ResourceName	m_sIconImageSet

string	m_sIconImageName

string	m_sWriteIconButtonName

float	m_fOpacityDefault

float	m_fOpacityFocused

ref Color	m_BackgroundDefault

ref Color	m_BackgroundInteracting

ref Color	m_BackgroundFocused

string	m_sWarningText

SCR_ModularButtonComponent	m_WriteIconButton

SCR_WidgetHintComponent	m_Hint

ref Color	COLOR_INVALID_INPUT = UIColors.WARNING

ref Color	COLOR_VALID_INPUT = Color.White

MultilineEditBoxWidget	m_wMultilineEditBoxWidget

EditBoxWidget	m_wEditBoxWidget

SCR_EventHandlerComponent	m_EVHComponent

bool	m_bIsFocused

bool	m_bIsInWriteMode

bool	m_bIsInWriteModePrevious

bool	m_bValidInput = true

bool	m_bIsTyping

ref Color	m_BackgroundCurrent

string	m_sTextPrevious

Protected Attributes inherited from SCR_ChangeableComponentBase
bool	m_bUseLabel

string	m_sLabel

bool	m_bForceSize

float	m_fSizeWithLabel

float	m_fSizeWithoutLabel

ResourceName	m_sLabelLayout

string	m_sSizeLayout

Widget	m_wBorder

Widget	m_wBackground

Widget	m_wLabelRoot

Protected Attributes inherited from SCR_WLibComponentBase
string	m_sSoundHovered

string	m_sSoundClicked

float	m_fAnimationTime

bool	m_bMouseOverToFocus

float	m_fDisabledOpacity

float	m_fAnimationRate

Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget	m_wRoot

Static Protected Attributes
const int	INTERACTION_STATE_UPDATE_FREQUENCY = 50

const int	FOCUS_LOST_INTERACTION_STATE_UPDATE_DELAY = 1000 / UIConstants.FADE_RATE_DEFAULT

Additional Inherited Members
Static Public Attributes inherited from SCR_WLibComponentBase
static const float	START_ANIMATION_RATE = 10001

static const float	START_ANIMATION_PERIOD = 250

Member Function Documentation

◆ ActivateWriteMode()

void SCR_EditBoxComponent.ActivateWriteMode ( bool refocus = false )

Set write mode of editbox handler.

◆ ChangeOverlayColor()

void SCR_EditBoxComponent.ChangeOverlayColor ( Color color )

◆ ClearInteractionState()

void SCR_EditBoxComponent.ClearInteractionState ( )

◆ ClearInvalidInput()

void SCR_EditBoxComponent.ClearInvalidInput ( )

◆ ConfirmValue()

void SCR_EditBoxComponent.ConfirmValue ( string value )

Set string value to editbox and confirm.

◆ GetEditBoxComponent()

static SCR_EditBoxComponent SCR_EditBoxComponent.GetEditBoxComponent	(	string	name,
		Widget	parent,
		bool	searchAllChildren = `true`
	)

static

Static method to easily find component by providing name and parent.

Searching all children will go through whole hierarchy, instead of immediate chidren

◆ GetEditBoxText()

string SCR_EditBoxComponent.GetEditBoxText ( )

protected

◆ GetEditBoxWidget()

Widget SCR_EditBoxComponent.GetEditBoxWidget ( )

◆ GetEVHComponent()

SCR_EventHandlerComponent SCR_EditBoxComponent.GetEVHComponent ( )

◆ GetHint()

SCR_WidgetHintComponent SCR_EditBoxComponent.GetHint ( )

◆ GetPlaceholderText()

string SCR_EditBoxComponent.GetPlaceholderText ( )

protected

◆ GetPlaceHolderText()

string SCR_EditBoxComponent.GetPlaceHolderText ( )

◆ GetValue()

string SCR_EditBoxComponent.GetValue ( )

◆ HandlerAttached()

override void SCR_EditBoxComponent.HandlerAttached ( Widget w )

Implements SCR_ChangeableComponentBase.

Implemented in SCR_EditBoxSearchComponent.

◆ HandlerDeattached()

override void SCR_EditBoxComponent.HandlerDeattached ( Widget w )

◆ IsInWriteMode()

bool SCR_EditBoxComponent.IsInWriteMode ( )

◆ IsValidInput()

bool SCR_EditBoxComponent.IsValidInput ( )

◆ OnCancel()

void SCR_EditBoxComponent.OnCancel ( )

protected

◆ OnConfirm()

void SCR_EditBoxComponent.OnConfirm ( Widget w )

protected

Implemented in SCR_EditBoxSearchComponent.

◆ OnFocus()

override bool SCR_EditBoxComponent.OnFocus	(	Widget	w,
		int	x,
		int	y
	)

Implements SCR_ChangeableComponentBase.

◆ OnHandlerFocus()

void SCR_EditBoxComponent.OnHandlerFocus ( )

Implemented in SCR_EditBoxSearchComponent.

◆ OnHandlerFocusLost()

void SCR_EditBoxComponent.OnHandlerFocusLost ( )

Implemented in SCR_EditBoxSearchComponent.

◆ OnInternalButtonClicked()

void SCR_EditBoxComponent.OnInternalButtonClicked ( )

protected

◆ OnInvalidInput()

void SCR_EditBoxComponent.OnInvalidInput ( )

◆ OnValueChanged()

void SCR_EditBoxComponent.OnValueChanged ( )

◆ ResetOverlayColor()

void SCR_EditBoxComponent.ResetOverlayColor ( )

◆ SetEditBoxText()

void SCR_EditBoxComponent.SetEditBoxText ( string text )

protected

◆ SetPlaceholderText()

void SCR_EditBoxComponent.SetPlaceholderText ( string str )

◆ SetValue()

void SCR_EditBoxComponent.SetValue ( string value )

User API.

◆ ShowHint()

void SCR_EditBoxComponent.ShowHint ( bool show )

◆ ShowWriteIcon()

void SCR_EditBoxComponent.ShowWriteIcon ( bool show )

◆ UpdateBackgroundColor()

void SCR_EditBoxComponent.UpdateBackgroundColor ( )

protected

◆ UpdateInteractionState()

void SCR_EditBoxComponent.UpdateInteractionState ( bool forceDisabled )

Implemented in SCR_EditBoxSearchComponent.

Member Data Documentation

◆ COLOR_INVALID_INPUT

ref Color SCR_EditBoxComponent.COLOR_INVALID_INPUT = UIColors.WARNING

protected

◆ COLOR_VALID_INPUT

ref Color SCR_EditBoxComponent.COLOR_VALID_INPUT = Color.White

protected

◆ FOCUS_LOST_INTERACTION_STATE_UPDATE_DELAY

const int SCR_EditBoxComponent.FOCUS_LOST_INTERACTION_STATE_UPDATE_DELAY = 1000 / UIConstants.FADE_RATE_DEFAULT

staticprotected

◆ INTERACTION_STATE_UPDATE_FREQUENCY

const int SCR_EditBoxComponent.INTERACTION_STATE_UPDATE_FREQUENCY = 50

staticprotected

◆ m_BackgroundCurrent

ref Color SCR_EditBoxComponent.m_BackgroundCurrent

protected

◆ m_BackgroundDefault

ref Color SCR_EditBoxComponent.m_BackgroundDefault

protected

◆ m_BackgroundFocused

ref Color SCR_EditBoxComponent.m_BackgroundFocused

protected

◆ m_BackgroundInteracting

ref Color SCR_EditBoxComponent.m_BackgroundInteracting

protected

◆ m_bIsFocused

bool SCR_EditBoxComponent.m_bIsFocused

protected

◆ m_bIsInWriteMode

bool SCR_EditBoxComponent.m_bIsInWriteMode

protected

◆ m_bIsInWriteModePrevious

bool SCR_EditBoxComponent.m_bIsInWriteModePrevious

protected

◆ m_bIsTyping

bool SCR_EditBoxComponent.m_bIsTyping

protected

◆ m_bShowInvalidInputWarning

bool SCR_EditBoxComponent.m_bShowInvalidInputWarning

protected

◆ m_bShowWriteIcon

bool SCR_EditBoxComponent.m_bShowWriteIcon

protected

◆ m_bValidInput

bool SCR_EditBoxComponent.m_bValidInput = true

protected

◆ m_EVHComponent

SCR_EventHandlerComponent SCR_EditBoxComponent.m_EVHComponent

protected

◆ m_fColorsAnimationTime

float SCR_EditBoxComponent.m_fColorsAnimationTime

protected

◆ m_fOpacityDefault

float SCR_EditBoxComponent.m_fOpacityDefault

protected

◆ m_fOpacityFocused

float SCR_EditBoxComponent.m_fOpacityFocused

protected

◆ m_Hint

SCR_WidgetHintComponent SCR_EditBoxComponent.m_Hint

protected

◆ m_OnCancel

ref ScriptInvokerVoid SCR_EditBoxComponent.m_OnCancel = new ScriptInvokerVoid()

◆ m_OnConfirm

ref ScriptInvoker SCR_EditBoxComponent.m_OnConfirm = new ScriptInvoker()

◆ m_OnFocusChangedEditBox

ref ScriptInvoker SCR_EditBoxComponent.m_OnFocusChangedEditBox = new ScriptInvoker()

◆ m_OnTextChange

ref ScriptInvokerString SCR_EditBoxComponent.m_OnTextChange = new ScriptInvokerString()

◆ m_OnWriteModeEnter

ref ScriptInvokerVoid SCR_EditBoxComponent.m_OnWriteModeEnter = new ScriptInvokerVoid()

◆ m_OnWriteModeLeave

ref ScriptInvokerString SCR_EditBoxComponent.m_OnWriteModeLeave = new ScriptInvokerString()

◆ m_sIconImageName

string SCR_EditBoxComponent.m_sIconImageName

protected

◆ m_sIconImageSet

ResourceName SCR_EditBoxComponent.m_sIconImageSet

protected

◆ m_sTextPrevious

string SCR_EditBoxComponent.m_sTextPrevious

protected

◆ m_sWarningText

string SCR_EditBoxComponent.m_sWarningText

protected

◆ m_sWriteIconButtonName

string SCR_EditBoxComponent.m_sWriteIconButtonName

protected

◆ m_wColorOverlay

Widget SCR_EditBoxComponent.m_wColorOverlay

◆ m_wEditBackground

Widget SCR_EditBoxComponent.m_wEditBackground

◆ m_wEditBox

Widget SCR_EditBoxComponent.m_wEditBox

◆ m_wEditBoxWidget

EditBoxWidget SCR_EditBoxComponent.m_wEditBoxWidget

protected

◆ m_wHorizontalLayout

Widget SCR_EditBoxComponent.m_wHorizontalLayout

◆ m_wImgWriteIcon

ImageWidget SCR_EditBoxComponent.m_wImgWriteIcon

◆ m_wMultilineEditBoxWidget

MultilineEditBoxWidget SCR_EditBoxComponent.m_wMultilineEditBoxWidget

protected

◆ m_WriteIconButton

SCR_ModularButtonComponent SCR_EditBoxComponent.m_WriteIconButton

protected

◆ m_wWarningIcon

Widget SCR_EditBoxComponent.m_wWarningIcon

◆ m_wWriteIconScale

Widget SCR_EditBoxComponent.m_wWriteIconScale

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

Game/UI/Components/WidgetLibrary/SCR_EditBox/SCR_EditBoxComponent.c

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ ActivateWriteMode()

◆ ChangeOverlayColor()

◆ ClearInteractionState()

◆ ClearInvalidInput()

◆ ConfirmValue()

◆ GetEditBoxComponent()

◆ GetEditBoxText()

◆ GetEditBoxWidget()

◆ GetEVHComponent()

◆ GetHint()

◆ GetPlaceholderText()

◆ GetPlaceHolderText()

◆ GetValue()

◆ HandlerAttached()

◆ HandlerDeattached()

◆ IsInWriteMode()

◆ IsValidInput()

◆ OnCancel()

◆ OnConfirm()

◆ OnFocus()

◆ OnHandlerFocus()

◆ OnHandlerFocusLost()

◆ OnInternalButtonClicked()

◆ OnInvalidInput()

◆ OnValueChanged()

◆ ResetOverlayColor()

◆ SetEditBoxText()

◆ SetPlaceholderText()

◆ SetValue()

◆ ShowHint()

◆ ShowWriteIcon()

◆ UpdateBackgroundColor()

◆ UpdateInteractionState()

Member Data Documentation

◆ COLOR_INVALID_INPUT

◆ COLOR_VALID_INPUT

◆ FOCUS_LOST_INTERACTION_STATE_UPDATE_DELAY

◆ INTERACTION_STATE_UPDATE_FREQUENCY

◆ m_BackgroundCurrent

◆ m_BackgroundDefault

◆ m_BackgroundFocused

◆ m_BackgroundInteracting

◆ m_bIsFocused

◆ m_bIsInWriteMode

◆ m_bIsInWriteModePrevious

◆ m_bIsTyping

◆ m_bShowInvalidInputWarning

◆ m_bShowWriteIcon

◆ m_bValidInput

◆ m_EVHComponent

◆ m_fColorsAnimationTime

◆ m_fOpacityDefault

◆ m_fOpacityFocused

◆ m_Hint

◆ m_OnCancel

◆ m_OnConfirm

◆ m_OnFocusChangedEditBox

◆ m_OnTextChange

◆ m_OnWriteModeEnter

◆ m_OnWriteModeLeave

◆ m_sIconImageName

◆ m_sIconImageSet

◆ m_sTextPrevious

◆ m_sWarningText

◆ m_sWriteIconButtonName

◆ m_wColorOverlay

◆ m_wEditBackground

◆ m_wEditBox

◆ m_wEditBoxWidget

◆ m_wHorizontalLayout

◆ m_wImgWriteIcon

◆ m_wMultilineEditBoxWidget