SCR_ScrollBarComponent Interface Reference

Scripte WLib scroll bar Can be controlled indivualy and be used for multiple purporse
More...

Inheritance diagram for SCR_ScrollBarComponent:

Public Member Functions
override void	HandlerAttached (Widget w)
void	SetupHandlerFill (float fillAmount)
	Set amount of handler fill in percent.
void	SetupPosition (float fillAmount, float pos)
	Setup fill of top and boom fillers by handler fill amount and current scroll position.
void	MoveHandlerPos (float pos)
float	GetHandlerPosition ()
Public Member Functions inherited from SCR_WLibComponentBase
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)
void	SetData (Managed data)
	Store custom data.
Managed	GetData ()
	Get stored data.
Public Member Functions inherited from SCR_ScriptedWidgetComponent
Widget	GetRootWidget ()
bool	IsVisible ()

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

Protected Member Functions
void	DragHandler ()
void	SetupScrollbarProperties ()
	Setup base position and size properties.
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
string	WIDGET_BACKGROUND = "Background"
string	WIDGET_HANDLER = "Handler"
string	WIDGET_FILLER_TOP = "FillerTop"
string	WIDGET_FILLER_BOTTOM = "FillerBottom"
Widget	m_wBackground
Widget	m_wHandler
Widget	m_wFillerTop
Widget	m_wFillerBottom
bool	m_IsClicked = false
int	mouseX
int	mouseY = 0
float	m_fRootPosY
float	m_fRootSizeY
float	m_fHandlerAmount = 1
float	m_fHandlerPositon = 0
ref SCR_ScrollBarHandleComponent	m_Handle
Protected Attributes inherited from SCR_WLibComponentBase
string	m_sSoundHovered
string	m_sSoundClicked
string	m_sSoundContainerClosed
float	m_fAnimationTime
bool	m_bMouseOverToFocus
float	m_fDisabledOpacity
float	m_fAnimationRate
ref Managed	m_UserData
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

Detailed Description

Scripte WLib scroll bar Can be controlled indivualy and be used for multiple purporse

Member Function Documentation

DragHandler()

void SCR_ScrollBarComponent.DragHandler ( )

protected

GetHandlerPosition()

float SCR_ScrollBarComponent.GetHandlerPosition

(

)

HandlerAttached()

override void SCR_ScrollBarComponent.HandlerAttached

(

Widget

w

)

Implements SCR_WLibComponentBase.

MoveHandlerPos()

void SCR_ScrollBarComponent.MoveHandlerPos

(

float

pos

)

SetupHandlerFill()

void SCR_ScrollBarComponent.SetupHandlerFill

(

float

fillAmount

)

Set amount of handler fill in percent.

SetupPosition()

void SCR_ScrollBarComponent.SetupPosition	(	float	fillAmount,
		float	pos )

Setup fill of top and boom fillers by handler fill amount and current scroll position.

SetupScrollbarProperties()

void SCR_ScrollBarComponent.SetupScrollbarProperties ( )

protected

Setup base position and size properties.

Member Data Documentation

m_fHandlerAmount

float SCR_ScrollBarComponent.m_fHandlerAmount = 1

protected

m_fHandlerPositon

float SCR_ScrollBarComponent.m_fHandlerPositon = 0

protected

m_fRootPosY

float SCR_ScrollBarComponent.m_fRootPosY

protected

m_fRootSizeY

float SCR_ScrollBarComponent.m_fRootSizeY

protected

m_Handle

ref SCR_ScrollBarHandleComponent SCR_ScrollBarComponent.m_Handle

protected

m_IsClicked

bool SCR_ScrollBarComponent.m_IsClicked = false

protected

m_OnScroll

ref ScriptInvoker SCR_ScrollBarComponent.m_OnScroll = new ScriptInvoker

m_wBackground

Widget SCR_ScrollBarComponent.m_wBackground

protected

m_wFillerBottom

Widget SCR_ScrollBarComponent.m_wFillerBottom

protected

m_wFillerTop

Widget SCR_ScrollBarComponent.m_wFillerTop

protected

m_wHandler

Widget SCR_ScrollBarComponent.m_wHandler

protected

mouseX

int SCR_ScrollBarComponent.mouseX

protected

mouseY

int SCR_ScrollBarComponent.mouseY = 0

protected

WIDGET_BACKGROUND

string SCR_ScrollBarComponent.WIDGET_BACKGROUND = "Background"

protected

WIDGET_FILLER_BOTTOM

string SCR_ScrollBarComponent.WIDGET_FILLER_BOTTOM = "FillerBottom"

protected

WIDGET_FILLER_TOP

string SCR_ScrollBarComponent.WIDGET_FILLER_TOP = "FillerTop"

protected

WIDGET_HANDLER

string SCR_ScrollBarComponent.WIDGET_HANDLER = "Handler"

protected

---

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

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