This is refactored checkbox preserving its own class and API for compatability purposes. More...

Inheritance diagram for SCR_CheckboxComponent:

Public Member Functions
bool	IsChecked ()

void	SetChecked (bool value, bool animate=true, bool playSound=true)

override void	OnElementChanged (SCR_ButtonBaseComponent comp, bool state)

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

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

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

void	OnElementClicked (SCR_ButtonBaseComponent comp)

void	OnElementChanged (SCR_ButtonBaseComponent comp, bool state)

override bool	SetCurrentItem (int i, bool playSound=false, bool animate=false)

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

int	GetItems (notnull array< SCR_ButtonBaseComponent > elements)

SCR_ButtonBaseComponent	GetItem (int index)

override int	AddItem (string item, bool last=false, Managed data=null)

override void	ClearAll ()

override void	RemoveItem (int item, bool last=false)

bool	IsItemSelected (int index)

void	SetItemSelected (int index, bool select, bool animate=true)

void	SetFocusedItem (int index, bool animate=true)

void	SetFocusedItem (SCR_ButtonBaseComponent element, bool animate=true)

int	GetFocusedItem ()

Public Member Functions inherited from SCR_SelectionWidgetComponent
int	AddItem (string item, bool last=false, Managed data=null)

void	ClearAll ()

void	RemoveItem (int item, bool last=false)

int	GetCurrentIndex ()

string	GetCurrentItem ()

Managed	GetCurrentItemData ()

string	GetItemName (int item)

Managed	GetItemData (int item)

int	GetNumItems ()

bool	SetCurrentItem (int i, bool playSound=false, bool animate=false)

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_CheckboxComponent	GetCheckboxComponent (string name, Widget parent, bool searchAllChildren=true)

Static Public Member Functions inherited from SCR_ToolboxComponent
static SCR_ToolboxComponent	GetToolboxComponent (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_SelectionWidgetComponent
static SCR_SelectionWidgetComponent	GetSelectionComponent (string name, Widget parent, bool searchAllChildren=true)

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.

Additional Inherited Members
Public Attributes inherited from SCR_ToolboxComponent
bool	m_bAllowMultiselection

ResourceName	m_ElementLayout

float	m_fElementSpacing

bool	m_bCycleMode

ref array< SCR_ButtonBaseComponent >	m_aSelectionElements = new array<SCR_ButtonBaseComponent>

SCR_ButtonBaseComponent	m_FocusedElement

Public Attributes inherited from SCR_SelectionWidgetComponent
ref array< string >	m_aElementNames

int	m_iSelectedItem

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

Protected Member Functions inherited from SCR_ToolboxComponent
void	CreateWidgets ()

void	ClearWidgets ()

void	SetInitialState ()

void	OnMenuSelect ()

SCR_ButtonBaseComponent	GetFirstSelectedIndex ()

void	OnMenuLeft ()

void	OnMenuRight ()

int	GetNextValidItem (bool toLeft)

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 inherited from SCR_ToolboxComponent
Widget	m_wButtonRow

Protected Attributes inherited from SCR_SelectionWidgetComponent
ref array< ref Managed >	m_aElementData = new array<ref Managed>

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

Detailed Description

This is refactored checkbox preserving its own class and API for compatability purposes.

Member Function Documentation

◆ GetCheckboxComponent()

static SCR_CheckboxComponent SCR_CheckboxComponent.GetCheckboxComponent	(	string	name,
		Widget	parent,
		bool	searchAllChildren = `true`
	)

static

◆ IsChecked()

bool SCR_CheckboxComponent.IsChecked ( )

◆ OnElementChanged()

override void SCR_CheckboxComponent.OnElementChanged	(	SCR_ButtonBaseComponent	comp,
		bool	state
	)

Implements SCR_ToolboxComponent.

◆ SetChecked()

void SCR_CheckboxComponent.SetChecked	(	bool	value,
		bool	animate = `true`,
		bool	playSound = `true`
	)

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

Game/UI/Components/WidgetLibrary/SCR_CheckBox/SCR_CheckboxComponent.c

Public Member Functions