Table of Contents

Class ScrollablePanel

Namespace
TaleWorlds.GauntletUI.BaseTypes
Assembly
TaleWorlds.GauntletUI.dll
public class ScrollablePanel : Widget
Inheritance
ScrollablePanel
Derived
Inherited Members
Extension Methods

Constructors

ScrollablePanel(UIContext)

public ScrollablePanel(UIContext context)

Parameters

context UIContext

Fields

ControllerScrollSpeed

public float ControllerScrollSpeed

Field Value

float

MouseScrollAxis

public AlignmentAxis MouseScrollAxis

Field Value

AlignmentAxis

MouseScrollSpeed

public float MouseScrollSpeed

Field Value

float

_canScrollHorizontal

protected bool _canScrollHorizontal

Field Value

bool

_canScrollVertical

protected bool _canScrollVertical

Field Value

bool

Properties

ActiveScrollbar

public ScrollbarWidget ActiveScrollbar { get; }

Property Value

ScrollbarWidget

AutoAdjustScrollbarHandleSize

[Editor(false)]
public bool AutoAdjustScrollbarHandleSize { get; set; }

Property Value

bool

AutoHideScrollBarHandle

[Editor(false)]
public bool AutoHideScrollBarHandle { get; set; }

Property Value

bool

AutoHideScrollBars

[Editor(false)]
public bool AutoHideScrollBars { get; set; }

Property Value

bool

ClipRect

public Widget ClipRect { get; set; }

Property Value

Widget

FixedHeader

public Widget FixedHeader { get; set; }

Property Value

Widget

HorizontalScrollbar

public ScrollbarWidget HorizontalScrollbar { get; set; }

Property Value

ScrollbarWidget

InnerPanel

public Widget InnerPanel { get; set; }

Property Value

Widget

OnlyAcceptScrollEventIfCanScroll

[Editor(false)]
public bool OnlyAcceptScrollEventIfCanScroll { get; set; }

Property Value

bool

ScrolledHeader

public Widget ScrolledHeader { get; set; }

Property Value

Widget

UpdateScrollbarVisibility

public bool UpdateScrollbarVisibility { get; set; }

Property Value

bool

VerticalScrollbar

public ScrollbarWidget VerticalScrollbar { get; set; }

Property Value

ScrollbarWidget

Methods

GetScrollXValueForWidget(Widget, float, float)

protected float GetScrollXValueForWidget(Widget widget, float widgetTargetXValue, float offset)

Parameters

widget Widget
widgetTargetXValue float
offset float

Returns

float

GetScrollYValueForWidget(Widget, float, float)

protected float GetScrollYValueForWidget(Widget widget, float widgetTargetYValue, float offset)

Parameters

widget Widget
widgetTargetYValue float
offset float

Returns

float

OnLateUpdate(float)

protected override void OnLateUpdate(float dt)

Parameters

dt float

OnMouseScroll()

protected override void OnMouseScroll()

OnPreviewMouseScroll()

protected override bool OnPreviewMouseScroll()

Returns

bool

OnPreviewRightStickMovement()

protected override bool OnPreviewRightStickMovement()

Returns

bool

OnRightStickMovement()

protected override void OnRightStickMovement()

ResetTweenSpeed()

public void ResetTweenSpeed()

ScrollToChild(Widget, float, float, int, int, float, float)

public void ScrollToChild(Widget targetWidget, float horizontalTargetValue = -1, float verticalTargetValue = -1, int horizontalOffsetInPixels = 0, int verticalOffsetInPixels = 0, float verticalInterpolationTime = 0, float horizontalInterpolationTime = 0)

Parameters

targetWidget Widget
horizontalTargetValue float
verticalTargetValue float
horizontalOffsetInPixels int
verticalOffsetInPixels int
verticalInterpolationTime float
horizontalInterpolationTime float

SetActiveCursor(MouseCursors)

protected void SetActiveCursor(UIContext.MouseCursors cursor)

Parameters

cursor UIContext.MouseCursors

SetHorizontalScrollTarget(float, float)

public void SetHorizontalScrollTarget(float targetValue, float interpolationDuration)

Parameters

targetValue float
interpolationDuration float

SetVerticalScrollTarget(float, float)

public void SetVerticalScrollTarget(float targetValue, float interpolationDuration)

Parameters

targetValue float
interpolationDuration float

Events

OnScroll

public event Action<float> OnScroll

Event Type

Action<float>

This page was last modified at 09/01/2024 16:12:00 +00:00 (UTC).