Class ScrollSelectionBox<TContainer, TElement, TValue>

Namespace

RichHudFramework.UI

Assembly

RichHudClient.dll

A scrollable list of arbitrary selectable UI elements. Generic SelectionBox using ScrollBox

public class ScrollSelectionBox<TContainer, TElement, TValue> : SelectionBox<ScrollBox<TContainer, TElement>, TContainer, TElement, TValue>, IReadOnlyHudElement, IReadOnlyHudNode, IReadOnlyHudParent, IEntryBox<TContainer, TElement>, IEnumerable<TContainer>, IEnumerable, IValueControl<TContainer>, IValueControl, IClickableElement, IFocusableElement where TContainer : class, IListBoxEntry<TElement, TValue>, new() where TElement : HudElementBase, IMinLabelElement

Type Parameters

TContainer

Container element type wrapping the UI element

TElement

UI element in the list

TValue

Data type stored associated with each entry

Inheritance

object

HudParentBase

HudNodeBase

HudElementBase

SelectionBoxBase<ScrollBox<TContainer, TElement>, TContainer, TElement>

SelectionBox<ScrollBox<TContainer, TElement>, TContainer, TElement, TValue>

ScrollSelectionBox<TContainer, TElement, TValue>

Implements

IReadOnlyHudElement

IReadOnlyHudNode

IReadOnlyHudParent

IEntryBox<TContainer, TElement>

IEnumerable<TContainer>

IEnumerable

IValueControl<TContainer>

IValueControl

IClickableElement

IFocusableElement

Derived

ListBox<TContainer, TElement, TValue>

Inherited Members

ListContainer

MemberPadding

ListPadding

LineHeight

border

AddNew()

Add(RichText, TValue, bool)

AddRange(IReadOnlyList<MyTuple<RichText, TValue, bool>>)

Insert(int, RichText, TValue, bool)

RemoveAt(int)

Remove(TContainer)

RemoveRange(int, int)

ClearEntries()

SetSelection(TValue)

ValueChanged

UpdateValueCallback

ListContainer

EntryList

HighlightColor

FocusColor

TabColor

HighlightPadding

Format

FocusTextColor

Value

SelectionIndex

Count

FocusHandler

MouseInput

IsMousedOver

GetEnumerator()

IEnumerable.GetEnumerator()

SetSelectionAt(int)

OffsetSelectionIndex(int, bool)

SetSelection(TContainer)

ClearSelection()

GetRangeSize(int, int)

Size

Width

Height

Padding

UnpaddedSize

Origin

Offset

Position

ParentAlignment

DimAlignment

UseCursor

ShareCursor

IsMasking

IsSelectivelyMasked

CanIgnoreMasking

IsMousedOver

CachedSize

OriginAlignment

MaskingBox

IReadOnlyHudNode.Parent

Parent

Registered

OverlayOffset

Register(HudParentBase)

Unregister()

HudSpace

Visible

InputEnabled

ZOffset

Measure()

Layout()

Draw()

InputDepth()

HandleInput(Vector2)

RegisterChild(HudNodeBase)

RemoveChild(HudNodeBase)

Constructors

ScrollSelectionBox()

public ScrollSelectionBox()

ScrollSelectionBox(HudParentBase)

public ScrollSelectionBox(HudParentBase parent)

Parameters

parent HudParentBase

Properties

Color

Background color

public Color Color { get; set; }

Property Value

Color

EnableScrolling

If enabled scrolling using the scrollbar and mousewheel will be allowed

public virtual bool EnableScrolling { get; set; }

Property Value

bool

MinLength

Minimum total length (on the align axis) of visible members allowed in the scrollbox.

public virtual float MinLength { get; set; }

Property Value

float

MinVisibleCount

Minimum number of visible elements allowed. Supercedes maximum length. If the number of elements that can fit within the maximum length is less than this value, then this element will expand beyond its maximum size.

public virtual int MinVisibleCount { get; set; }

Property Value

int

UseSmoothScrolling

Enable/disable smooth scrolling and range clipping

public virtual bool UseSmoothScrolling { get; set; }

Property Value

bool