Inheritance diagram for SCR_SliderComponent:

[legend]

Public Member Functions
override void	HandlerAttached (Widget w)

override void	HandlerDeattached (Widget w)

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

void	SetValue (float value)

ScriptInvoker	GetOnChangedFinal ()

float	GetValue ()

void	SetFormatText (string text)

string	GetFormatText ()

void	ShowCustomValue (string value)

void	SetSliderSettings (float min, float max, float step, string formatText=string.Empty)

void	SetMin (float min)

void	SetMax (float max)

void	SetStep (float step)

float	GetMin ()

float	GetMax ()

float	GetStep ()

void	SetShownValueMultiplier (float multiplier)

float	GetShownValueMultiplier ()

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_SliderComponent	GetSliderComponent (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
void	OnValueChanged (Widget w)

float	UpdateValue ()

float	RoundValue (float value, int precision)

void	OnValueFinal (Widget w)

void	OnSliderFocus ()

void	OnSliderFocusLost ()

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_fValue

float	m_fMinValue

float	m_fMaxValue

float	m_fStep

string	m_sFormatText

float	m_fShownValueMultiplier

float	m_fShownSecondaryMultiplier

float	m_fValueMultiplier

float	m_fSecondaryMultiplier

float	m_fValueOffset

float	m_fSecondaryOffset

bool	m_bClampValue

bool	m_bRoundValue

int	m_iDecimalPrecision

string	m_sChangeSound

TextWidget	m_wText

SliderWidget	m_wSlider

float	m_fOldValue

ref SCR_EventHandlerComponent	m_Handler

ref ScriptInvoker	m_OnChangedFinal

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_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

Member Function Documentation

◆ GetFormatText()

string SCR_SliderComponent.GetFormatText ( )

◆ GetMax()

float SCR_SliderComponent.GetMax ( )

◆ GetMin()

float SCR_SliderComponent.GetMin ( )

◆ GetOnChangedFinal()

ScriptInvoker SCR_SliderComponent.GetOnChangedFinal ( )

◆ GetShownValueMultiplier()

float SCR_SliderComponent.GetShownValueMultiplier ( )

◆ GetSliderComponent()

static SCR_SliderComponent SCR_SliderComponent.GetSliderComponent	(	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

◆ GetStep()

float SCR_SliderComponent.GetStep ( )

◆ GetValue()

float SCR_SliderComponent.GetValue ( )

◆ HandlerAttached()

override void SCR_SliderComponent.HandlerAttached ( Widget w )

Implements SCR_ChangeableComponentBase.

◆ HandlerDeattached()

override void SCR_SliderComponent.HandlerDeattached ( Widget w )

◆ OnFocus()

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

Implements SCR_ChangeableComponentBase.

◆ OnSliderFocus()

void SCR_SliderComponent.OnSliderFocus ( )

protected

◆ OnSliderFocusLost()

void SCR_SliderComponent.OnSliderFocusLost ( )

protected

◆ OnValueChanged()

void SCR_SliderComponent.OnValueChanged ( Widget w )

protected

◆ OnValueFinal()

void SCR_SliderComponent.OnValueFinal ( Widget w )

protected

◆ RoundValue()

float SCR_SliderComponent.RoundValue	(	float	value,
		int	precision
	)

protected

◆ SetFormatText()

void SCR_SliderComponent.SetFormatText ( string text )

◆ SetMax()

void SCR_SliderComponent.SetMax ( float max )

◆ SetMin()

void SCR_SliderComponent.SetMin ( float min )

◆ SetShownValueMultiplier()

void SCR_SliderComponent.SetShownValueMultiplier ( float multiplier )

◆ SetSliderSettings()

void SCR_SliderComponent.SetSliderSettings	(	float	min,
		float	max,
		float	step,
		string	formatText = `string::Empty`
	)

◆ SetStep()

void SCR_SliderComponent.SetStep ( float step )

◆ SetValue()

void SCR_SliderComponent.SetValue ( float value )

◆ ShowCustomValue()

void SCR_SliderComponent.ShowCustomValue ( string value )

◆ UpdateValue()

float SCR_SliderComponent.UpdateValue ( )

protected

Member Data Documentation

◆ m_bClampValue

bool SCR_SliderComponent.m_bClampValue

protected

◆ m_bRoundValue

bool SCR_SliderComponent.m_bRoundValue

protected

◆ m_fMaxValue

float SCR_SliderComponent.m_fMaxValue

protected

◆ m_fMinValue

float SCR_SliderComponent.m_fMinValue

protected

◆ m_fOldValue

float SCR_SliderComponent.m_fOldValue

protected

◆ m_fSecondaryMultiplier

float SCR_SliderComponent.m_fSecondaryMultiplier

protected

◆ m_fSecondaryOffset

float SCR_SliderComponent.m_fSecondaryOffset

protected

◆ m_fShownSecondaryMultiplier

float SCR_SliderComponent.m_fShownSecondaryMultiplier

protected

◆ m_fShownValueMultiplier

float SCR_SliderComponent.m_fShownValueMultiplier

protected

◆ m_fStep

float SCR_SliderComponent.m_fStep

protected

◆ m_fValue

float SCR_SliderComponent.m_fValue

protected

◆ m_fValueMultiplier

float SCR_SliderComponent.m_fValueMultiplier

protected

◆ m_fValueOffset

float SCR_SliderComponent.m_fValueOffset

protected

◆ m_Handler

ref SCR_EventHandlerComponent SCR_SliderComponent.m_Handler

protected

◆ m_iDecimalPrecision

int SCR_SliderComponent.m_iDecimalPrecision

protected

◆ m_OnChangedFinal

ref ScriptInvoker SCR_SliderComponent.m_OnChangedFinal

protected

◆ m_sChangeSound

string SCR_SliderComponent.m_sChangeSound

protected

◆ m_sFormatText

string SCR_SliderComponent.m_sFormatText

protected

◆ m_wSlider

SliderWidget SCR_SliderComponent.m_wSlider

protected

◆ m_wText

TextWidget SCR_SliderComponent.m_wText

protected

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

Game/UI/Components/WidgetLibrary/SCR_Slider/SCR_SliderComponent.c

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ GetFormatText()

◆ GetMax()

◆ GetMin()

◆ GetOnChangedFinal()

◆ GetShownValueMultiplier()

◆ GetSliderComponent()

◆ GetStep()

◆ GetValue()

◆ HandlerAttached()

◆ HandlerDeattached()

◆ OnFocus()

◆ OnSliderFocus()

◆ OnSliderFocusLost()

◆ OnValueChanged()

◆ OnValueFinal()

◆ RoundValue()

◆ SetFormatText()

◆ SetMax()

◆ SetMin()

◆ SetShownValueMultiplier()

◆ SetSliderSettings()

◆ SetStep()

◆ SetValue()

◆ ShowCustomValue()

◆ UpdateValue()

Member Data Documentation

◆ m_bClampValue

◆ m_bRoundValue

◆ m_fMaxValue

◆ m_fMinValue

◆ m_fOldValue

◆ m_fSecondaryMultiplier

◆ m_fSecondaryOffset

◆ m_fShownSecondaryMultiplier

◆ m_fShownValueMultiplier

◆ m_fStep

◆ m_fValue

◆ m_fValueMultiplier

◆ m_fValueOffset

◆ m_Handler

◆ m_iDecimalPrecision

◆ m_OnChangedFinal

◆ m_sChangeSound

◆ m_sFormatText

◆ m_wSlider

◆ m_wText