IScrollable

Description

interface Tinman.Engine.GUI.IScrollable

Derived from

IFocusable

Extended by

Component abstract

Base interface for GUI components that provide scrollable content.

Public / Attributes

Height

public attribute Height → (get)

value : int32

The current component height, in pixels.

Height of this component in its parent containers client area.

Scroll​Height

public attribute ScrollHeight → (get)

value : int32

The current scroll height, in pixels.

Scroll height of this component.

Scroll​Tick

public attribute ScrollTick → (get)

value : int32

The scroll tick size, in pixels.

Returns the size of a single scroll tick.

Scroll​Width

public attribute ScrollWidth → (get)

value : int32

The current scroll width, in pixels.

Scroll width of this component.

Scroll​X

public attribute ScrollX → (get,set)

value : int32

The current scroll position.

The horizontal scroll position of this component.

Scroll​Y

public attribute ScrollY → (get,set)

value : int32

The current scroll position.

The vertical scroll position of this component.

Width

public attribute Width → (get)

value : int32

The current component width, in pixels.

Width of this component in its parent containers client area.

Extensions

Scroll​Relative

2 overloads

public static method ScrollRelative1 → (1)

v in : Vec2I

The relative amount to scroll.

Scrolls by the given relative amount.

public static method ScrollRelative2 → (2)

x in : int32

The relative X-amount to scroll.

y in : int32

The relative Y-amount to scroll.

Scrolls by the given relative amount.

Scroll​To

2 overloads

public static method ScrollTo1 → (1)

v in : Vec2I

The absolute position to scroll to.

Scrolls to the given absolute position.

public static method ScrollTo2 → (2)

x in : int32

The absolute X-position to scroll to.

y in : int32

The absolute Y-position to scroll to.

Scrolls to the given absolute position.

Scroll​Visible

public static method ScrollVisible → (1)

bounds in : Box2I

The bounds to make visible.

Scrolls so that the given bounds in become more visible.

If the given bounds in are already fully visible, the method silently returns.

If the top edge of bounds in is visible, the method scrolls so that the edge moves upwards.

If the bottom edge of bounds in is visible, the method scrolls so that the edge moves downwards.

If the left edge of bounds in is visible, the method scrolls so that the edge moves to the left.

If the right edge of bounds in is visible, the method will scrolls so that the edge moves to the right.

If none of the edges of the given bounds in is visible, the method silently returns.