Sandbox.Graphics.GUI.MyScrollbar Class Reference

Inheritance diagram for Sandbox.Graphics.GUI.MyScrollbar:

Public Member Functions
void	Init (float max, float page)
void	ChangeValue (float amount)
void	PageDown ()
void	PageUp ()
void	SetPage (float pageNumber)
abstract void	Layout (Vector2 position, float length)
abstract void	Draw (Color colorMask)
void	DebugDraw ()
abstract bool	HandleInput ()

Public Attributes
float	ScrollBarScale = 1
bool	Visible

Protected Types
enum	StateEnum { StateEnum.Ready, StateEnum.Drag }

Protected Member Functions
	MyScrollbar (MyGuiControlBase control, MyGuiCompositeTexture normalTexture, MyGuiCompositeTexture highlightTexture, MyGuiCompositeTexture backgroundTexture)
bool	CanScroll ()
virtual void	RefreshInternals ()

Protected Attributes
MyGuiCompositeTexture	m_backgroundTexture
MyGuiControlBase	OwnerControl
Vector2	Position
Vector2	CaretSize
float	Max
float	Page
StateEnum	State
MyGuiCompositeTexture	Texture

Properties
Vector2	Size [get, protected set]
bool	HasHighlight [get, set]
float	Value [get, set]
bool	IsOverCaret [get, protected set]

Events
Action< MyScrollbar >	ValueChanged

Detailed Description

Definition at line 8 of file MyScrollbar.cs.

Member Enumeration Documentation

enum Sandbox.Graphics.GUI.MyScrollbar.StateEnum

protected

Enumerator
Ready
Drag

Definition at line 10 of file MyScrollbar.cs.

Constructor & Destructor Documentation

Sandbox.Graphics.GUI.MyScrollbar.MyScrollbar ( MyGuiControlBase  control, MyGuiCompositeTexture  normalTexture, MyGuiCompositeTexture  highlightTexture, MyGuiCompositeTexture  backgroundTexture  )

inlineprotected

Definition at line 72 of file MyScrollbar.cs.

Member Function Documentation

bool Sandbox.Graphics.GUI.MyScrollbar.CanScroll ( )

inlineprotected

Definition at line 84 of file MyScrollbar.cs.

void Sandbox.Graphics.GUI.MyScrollbar.ChangeValue ( float  amount )

inline

Definition at line 98 of file MyScrollbar.cs.

void Sandbox.Graphics.GUI.MyScrollbar.DebugDraw ( )

inline

Definition at line 122 of file MyScrollbar.cs.

abstract void Sandbox.Graphics.GUI.MyScrollbar.Draw ( Color  colorMask )

pure virtual

Implemented in Sandbox.Graphics.GUI.MyHScrollbar, and Sandbox.Graphics.GUI.MyVScrollbar.

abstract bool Sandbox.Graphics.GUI.MyScrollbar.HandleInput ( )

pure virtual

Implemented in Sandbox.Graphics.GUI.MyHScrollbar, and Sandbox.Graphics.GUI.MyVScrollbar.

void Sandbox.Graphics.GUI.MyScrollbar.Init ( float  max, float  page  )

inline

Definition at line 89 of file MyScrollbar.cs.

abstract void Sandbox.Graphics.GUI.MyScrollbar.Layout ( Vector2  position, float  length  )

pure virtual

Implemented in Sandbox.Graphics.GUI.MyHScrollbar, and Sandbox.Graphics.GUI.MyVScrollbar.

void Sandbox.Graphics.GUI.MyScrollbar.PageDown ( )

inline

Definition at line 103 of file MyScrollbar.cs.

void Sandbox.Graphics.GUI.MyScrollbar.PageUp ( )

inline

Definition at line 108 of file MyScrollbar.cs.

virtual void Sandbox.Graphics.GUI.MyScrollbar.RefreshInternals ( )

inlineprotectedvirtual

Reimplemented in Sandbox.Graphics.GUI.MyHScrollbar, and Sandbox.Graphics.GUI.MyVScrollbar.

Definition at line 129 of file MyScrollbar.cs.

void Sandbox.Graphics.GUI.MyScrollbar.SetPage ( float  pageNumber )

inline

Definition at line 113 of file MyScrollbar.cs.

Member Data Documentation

Vector2 Sandbox.Graphics.GUI.MyScrollbar.CaretSize

protected

Definition at line 24 of file MyScrollbar.cs.

MyGuiCompositeTexture Sandbox.Graphics.GUI.MyScrollbar.m_backgroundTexture

protected

Definition at line 20 of file MyScrollbar.cs.

float Sandbox.Graphics.GUI.MyScrollbar.Max

protected

Definition at line 25 of file MyScrollbar.cs.

MyGuiControlBase Sandbox.Graphics.GUI.MyScrollbar.OwnerControl

protected

Definition at line 22 of file MyScrollbar.cs.

float Sandbox.Graphics.GUI.MyScrollbar.Page

protected

Definition at line 26 of file MyScrollbar.cs.

Vector2 Sandbox.Graphics.GUI.MyScrollbar.Position

protected

Definition at line 23 of file MyScrollbar.cs.

float Sandbox.Graphics.GUI.MyScrollbar.ScrollBarScale = 1

Definition at line 30 of file MyScrollbar.cs.

StateEnum Sandbox.Graphics.GUI.MyScrollbar.State

protected

Definition at line 27 of file MyScrollbar.cs.

MyGuiCompositeTexture Sandbox.Graphics.GUI.MyScrollbar.Texture

protected

Definition at line 28 of file MyScrollbar.cs.

bool Sandbox.Graphics.GUI.MyScrollbar.Visible

Definition at line 38 of file MyScrollbar.cs.

Property Documentation

bool Sandbox.Graphics.GUI.MyScrollbar.HasHighlight

getset

Definition at line 41 of file MyScrollbar.cs.

bool Sandbox.Graphics.GUI.MyScrollbar.IsOverCaret

getprotected set

Definition at line 68 of file MyScrollbar.cs.

Vector2 Sandbox.Graphics.GUI.MyScrollbar.Size

getprotected set

Definition at line 33 of file MyScrollbar.cs.

float Sandbox.Graphics.GUI.MyScrollbar.Value

getset

Definition at line 54 of file MyScrollbar.cs.

Event Documentation

Action<MyScrollbar> Sandbox.Graphics.GUI.MyScrollbar.ValueChanged

Definition at line 70 of file MyScrollbar.cs.

---

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

• Sources/Sandbox.Graphics/Gui/MyScrollbar.cs