Inheritance diagram for SCR_EditBoxSearchComponent:

[legend]

Public Member Functions
override bool	OnMouseEnter (Widget w, int x, int y)

override void	OnHandlerFocus ()

override void	OnHandlerFocusLost ()

override void	UpdateInteractionState (bool forceDisabled)

bool	SetMessage (string message)

Public Member Functions inherited from SCR_EditBoxComponent
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_EditBoxSearchComponent	GetEditBoxSearchComponent (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_EditBoxComponent
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.

Protected Member Functions
override void	HandlerAttached (Widget w)

override void	OnConfirm (Widget w)

void	UpdateWidgets (bool animate=true)

Protected Member Functions inherited from SCR_EditBoxComponent
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
bool	m_bColorizeText

ref Color	m_cDefault

ref Color	m_cFocused

ref Color	m_cSearched

string	m_sMessage

bool	m_bHideMessageOnSearch

ref array< Widget >	m_aColorizedElements = {}

SCR_ESearchBoxState	m_eState

bool	m_bIsFilterActive

RichTextWidget	m_wMessage

SCR_ModularButtonComponent	m_MessageButton

string	m_sLastSearch

Protected Attributes inherited from SCR_EditBoxComponent
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

Additional Inherited Members
Public Attributes inherited from SCR_EditBoxComponent
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

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

static const float	START_ANIMATION_PERIOD = 250

Static Protected Attributes inherited from SCR_EditBoxComponent
const int	INTERACTION_STATE_UPDATE_FREQUENCY = 50

const int	FOCUS_LOST_INTERACTION_STATE_UPDATE_DELAY = 1000 / UIConstants.FADE_RATE_DEFAULT

Member Function Documentation

◆ GetEditBoxSearchComponent()

static SCR_EditBoxSearchComponent SCR_EditBoxSearchComponent.GetEditBoxSearchComponent	(	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

◆ HandlerAttached()

override void SCR_EditBoxSearchComponent.HandlerAttached ( Widget w )

protected

Implements SCR_EditBoxComponent.

◆ OnConfirm()

override void SCR_EditBoxSearchComponent.OnConfirm ( Widget w )

protected

Implements SCR_EditBoxComponent.

◆ OnHandlerFocus()

override void SCR_EditBoxSearchComponent.OnHandlerFocus ( )

Implements SCR_EditBoxComponent.

◆ OnHandlerFocusLost()

override void SCR_EditBoxSearchComponent.OnHandlerFocusLost ( )

Implements SCR_EditBoxComponent.

◆ OnMouseEnter()

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

Implements SCR_ChangeableComponentBase.

◆ SetMessage()

bool SCR_EditBoxSearchComponent.SetMessage ( string message )

◆ UpdateInteractionState()

override void SCR_EditBoxSearchComponent.UpdateInteractionState ( bool forceDisabled )

Implements SCR_EditBoxComponent.

◆ UpdateWidgets()

void SCR_EditBoxSearchComponent.UpdateWidgets ( bool animate = true )

protected

Member Data Documentation

◆ m_aColorizedElements

ref array<Widget> SCR_EditBoxSearchComponent.m_aColorizedElements = {}

protected

◆ m_bColorizeText

bool SCR_EditBoxSearchComponent.m_bColorizeText

protected

◆ m_bHideMessageOnSearch

bool SCR_EditBoxSearchComponent.m_bHideMessageOnSearch

protected

◆ m_bIsFilterActive

bool SCR_EditBoxSearchComponent.m_bIsFilterActive

protected

◆ m_cDefault

ref Color SCR_EditBoxSearchComponent.m_cDefault

protected

◆ m_cFocused

ref Color SCR_EditBoxSearchComponent.m_cFocused

protected

◆ m_cSearched

ref Color SCR_EditBoxSearchComponent.m_cSearched

protected

◆ m_eState

SCR_ESearchBoxState SCR_EditBoxSearchComponent.m_eState

protected

◆ m_MessageButton

SCR_ModularButtonComponent SCR_EditBoxSearchComponent.m_MessageButton

protected

◆ m_sLastSearch

string SCR_EditBoxSearchComponent.m_sLastSearch

protected

◆ m_sMessage

string SCR_EditBoxSearchComponent.m_sMessage

protected

◆ m_wMessage

RichTextWidget SCR_EditBoxSearchComponent.m_wMessage

protected

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ GetEditBoxSearchComponent()

◆ HandlerAttached()

◆ OnConfirm()

◆ OnHandlerFocus()

◆ OnHandlerFocusLost()

◆ OnMouseEnter()

◆ SetMessage()

◆ UpdateInteractionState()

◆ UpdateWidgets()

Member Data Documentation

◆ m_aColorizedElements

◆ m_bColorizeText

◆ m_bHideMessageOnSearch

◆ m_bIsFilterActive

◆ m_cDefault

◆ m_cFocused

◆ m_cSearched

◆ m_eState

◆ m_MessageButton

◆ m_sLastSearch

◆ m_sMessage

◆ m_wMessage