SCR_CheckboxEditorAttributeUIComponent Interface Reference

Inheritance diagram for SCR_CheckboxEditorAttributeUIComponent:

Public Member Functions
override void	Init (Widget w, SCR_BaseEditorAttribute attribute)
	Initialize GUI from attribute.
override void	SetVariableToDefaultValue (SCR_BaseEditorAttributeVar var)
override void	SetFromVar (SCR_BaseEditorAttributeVar var)
	Update GUI from attribute variable.
override bool	OnChange (Widget w, int x, int y, bool finished)
override void	HandlerDeattached (Widget w)
Public Member Functions inherited from SCR_BaseEditorAttributeUIComponent
SCR_BaseEditorAttribute	GetAttribute ()
	Get attribute this component represents.
void	SetFromVar (SCR_BaseEditorAttributeVar var)
	Update GUI from attribute variable.
void	Init (Widget w, SCR_BaseEditorAttribute attribute)
	Initialize GUI from attribute.
override bool	OnChange (Widget w, int x, int y, bool finished)
void	ShowButtonDescription (SCR_AttributeButtonUIComponent button, bool showButtonDescription, string buttonDescription=string.Empty)
ScriptInvoker	GetOnAttributeChanged ()
	Called on attribute changed via UI.
ScriptInvoker	GetOnAttributeUIFocusChanged ()
	Called on focus changes.
ScriptInvoker	GetOnEnabledByAttribute ()
	Called when another attribute enables/disables the attribute.
ScriptInvoker	GetOnMouseLeave ()
	Called when the mouse leaves the attribute.
bool	GetTickboxEnabled ()
	Get if tickbox is enabled or not.
void	ToggleEnableAttributeTickbox ()
	Toggle tickbox UI, flipping the tickbox from true to false and viceversa.
bool	GetIsFocused ()
	Get if attribute is focused /return if attribute is focused.
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)
override void	HandlerDeattached (Widget w)

Protected Member Functions
void	OnChangeCheckbox (SCR_SelectionWidgetComponent selectionBox, bool value)
Protected Member Functions inherited from SCR_BaseEditorAttributeUIComponent
void	SetFromVarExternal (SCR_BaseEditorAttributeVar var, bool isReset)
void	SetFromVarOrDefault ()
void	ToggleButtonSelected (bool selected, int index, bool animated=true)
void	SetAsSubAttribute ()
void	AttributeValueChanged ()
void	ShowAttributeDescription ()
void	HideAttributeDescription ()
void	SetVariableToDefaultValue (SCR_BaseEditorAttributeVar var)
void	ToggleEnableAttribute (bool enabled)
void	ToggleEnable (bool enabled)
	Toggle UI enabled.
void	OnTickboxToggleChanged (bool toggle)
void	GamePadLockedSelectorFocusChanged (bool newFocus)
void	OnFocusAttributeWidget (Widget w)
	Callback for focus of widget used.
void	SetGamepadLockSelectorActive (bool isGamepad)

Protected Attributes
SCR_SelectionWidgetComponent	m_SelectionBoxComponent
Protected Attributes inherited from SCR_BaseEditorAttributeUIComponent
string	m_sUiComponentName
string	m_sTickBoxAttributeName
string	m_sAttributeHolder
string	m_sGamePadLockedSelectorName
string	m_sSubAttributeIndicatorName
float	m_fSubAttributeDisabledAlphaColor
ref SCR_EditorAttributeUIInfo	m_ButtonDescriptionUIInfo = new SCR_EditorAttributeUIInfo
SCR_AttributeButtonUIComponent	m_ActiveButtonDescription
SCR_ChangeableComponentBase	m_UIComponent
float	m_fBottomPadding = 1
bool	m_bIsSubAttribute
SCR_AttributeTickboxUIComponent	m_TickBoxAttribute
Widget	m_GamePadLockedSelector
SCR_AttributesManagerEditorComponent	m_AttributeManager
InputManager	m_InputManager
Widget	m_SubAttributeIndicator
Widget	m_wAttributeHolder
bool	m_bEnabledByAttribute
bool	m_bEnabledByTickbox
bool	m_bIsFocused
bool	m_bIsShowingDescription
bool	m_bShowButtonDescription
string	m_sButtonDescription
string	m_sButtonDescriptionParam1
ref ScriptInvoker	Event_OnAttributeChanged = new ScriptInvoker
ref ScriptInvoker	Event_OnEnabledByAttribute = new ScriptInvoker
ref ScriptInvoker	Event_OnAttributeUIFocusChanged = new ScriptInvoker
ref ScriptInvoker	Event_OnInputDeviceChanged = new ScriptInvoker
ref ScriptInvoker	Event_OnMouseLeave = new ScriptInvoker

Member Function Documentation

HandlerDeattached()

override void SCR_CheckboxEditorAttributeUIComponent.HandlerDeattached

(

Widget

w

)

Implements SCR_BaseEditorAttributeUIComponent.

Init()

override void SCR_CheckboxEditorAttributeUIComponent.Init	(	Widget	w,
		SCR_BaseEditorAttribute	attribute
	)

Initialize GUI from attribute.

To be overridden by inherited classes.

Parameters

w	Widget this component is attached to
attribute	Editor attribute this component represents

Implements SCR_BaseEditorAttributeUIComponent.

OnChange()

override bool SCR_CheckboxEditorAttributeUIComponent.OnChange	(	Widget	w,
		int	x,
		int	y,
		bool	finished
	)

Implements SCR_BaseEditorAttributeUIComponent.

OnChangeCheckbox()

void SCR_CheckboxEditorAttributeUIComponent.OnChangeCheckbox ( SCR_SelectionWidgetComponent  selectionBox, bool  value  )

protected

SetFromVar()

override void SCR_CheckboxEditorAttributeUIComponent.SetFromVar

(

SCR_BaseEditorAttributeVar

var

)

Update GUI from attribute variable.

Called when attributes are initialized in a dialog or when they are reset based on user request.

Parameters

var	Attribute variable

Implements SCR_BaseEditorAttributeUIComponent.

SetVariableToDefaultValue()

override void SCR_CheckboxEditorAttributeUIComponent.SetVariableToDefaultValue

(

SCR_BaseEditorAttributeVar

var

)

Implements SCR_BaseEditorAttributeUIComponent.

Member Data Documentation

m_SelectionBoxComponent

SCR_SelectionWidgetComponent SCR_CheckboxEditorAttributeUIComponent.m_SelectionBoxComponent

protected

---

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

• Game/Editor/UI/Components/Attributes/SCR_CheckboxEditorAttributeUIComponent.c