SCR_ScrollBarHandleComponent Interface Reference

Inheritance diagram for SCR_ScrollBarHandleComponent:

Public Member Functions
override void	HandlerAttached (Widget w)
override bool	OnMouseEnter (Widget w, int x, int y)
override bool	OnMouseLeave (Widget w, Widget enterW, int x, int y)
override bool	OnMouseButtonDown (Widget w, int x, int y, int button)
override bool	OnMouseButtonUp (Widget w, int x, int y, int button)
void	SetSizeY (float size)
float	GetSizeY ()
void	SetPositionY (float pos)
float	GetPositionY ()
float	GetMouseOffsetY ()
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 ()

Public Attributes
ref ScriptInvoker	m_OnDrag = new ScriptInvoker
Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Protected Member Functions
void	DragHandler ()
	Move with handler if handler is clicked.
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_bIsDragged = false
bool	m_bIsHovered = false
float	m_fSizeY
float	m_fPositionY
float	m_fMouseOffsetY
ref Color	COLOR_HANDLER_DEFAULT = UIColors.CONTRAST_COLOR
ref Color	COLOR_HANDLER_HOVERED = Color.White
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
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.
Static Public Attributes inherited from SCR_WLibComponentBase
static const float	START_ANIMATION_RATE = 10001
static const float	START_ANIMATION_PERIOD = 250

Member Function Documentation

DragHandler()

void SCR_ScrollBarHandleComponent.DragHandler ( )

protected

Move with handler if handler is clicked.

GetMouseOffsetY()

float SCR_ScrollBarHandleComponent.GetMouseOffsetY

(

)

GetPositionY()

float SCR_ScrollBarHandleComponent.GetPositionY

(

)

GetSizeY()

float SCR_ScrollBarHandleComponent.GetSizeY

(

)

HandlerAttached()

override void SCR_ScrollBarHandleComponent.HandlerAttached

(

Widget

w

)

Implements SCR_WLibComponentBase.

OnMouseButtonDown()

override bool SCR_ScrollBarHandleComponent.OnMouseButtonDown	(	Widget	w,
		int	x,
		int	y,
		int	button
	)

OnMouseButtonUp()

override bool SCR_ScrollBarHandleComponent.OnMouseButtonUp	(	Widget	w,
		int	x,
		int	y,
		int	button
	)

OnMouseEnter()

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

Implements SCR_WLibComponentBase.

OnMouseLeave()

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

SetPositionY()

void SCR_ScrollBarHandleComponent.SetPositionY

(

float

pos

)

SetSizeY()

void SCR_ScrollBarHandleComponent.SetSizeY

(

float

size

)

Member Data Documentation

COLOR_HANDLER_DEFAULT

ref Color SCR_ScrollBarHandleComponent.COLOR_HANDLER_DEFAULT = UIColors.CONTRAST_COLOR

protected

COLOR_HANDLER_HOVERED

ref Color SCR_ScrollBarHandleComponent.COLOR_HANDLER_HOVERED = Color.White

protected

m_bIsDragged

bool SCR_ScrollBarHandleComponent.m_bIsDragged = false

protected

m_bIsHovered

bool SCR_ScrollBarHandleComponent.m_bIsHovered = false

protected

m_fMouseOffsetY

float SCR_ScrollBarHandleComponent.m_fMouseOffsetY

protected

m_fPositionY

float SCR_ScrollBarHandleComponent.m_fPositionY

protected

m_fSizeY

float SCR_ScrollBarHandleComponent.m_fSizeY

protected

m_OnDrag

ref ScriptInvoker SCR_ScrollBarHandleComponent.m_OnDrag = new ScriptInvoker

---

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

• Game/UI/Components/WidgetLibrary/SCR_ScrollBar/SCR_ScrollBarHandleComponent.c