TINMAN 3D / REALTIME TERRAIN
Software Development Kit - User Manual

interface IScrollable in Tinman.AddOns.GUI

interface IScrollable extends IFocusable
  base of Component

Attributes

Height

Height of this component in its parent containers client area.

property Height { get }
type int32
value The current component height, in pixels.

ScrollHeight

Scroll height of this component.

property ScrollHeight { get }
type int32
value The current scroll height, in pixels.

ScrollTick

Returns the size of a single scroll tick.

property ScrollTick { get }
type int32
value The scroll tick size, in pixels.

ScrollWidth

Scroll width of this component.

property ScrollWidth { get }
type int32
value The current scroll width, in pixels.

ScrollX

The horizontal scroll position of this component.

property ScrollX { get set }
type int32
value The current scroll position.

ScrollY

The vertical scroll position of this component.

property ScrollY { get set }
type int32
value The current scroll position.

Width

Width of this component in its parent containers client area.

property Width { get }
type int32
value The current component width, in pixels.

Methods

Focus

Transfers the input focus to this component.

method Focus ()
returns [not-null] this
inherited IFocusable.Focus

Extensions

ScrollRelative

Scrolls by the given relative amount.

method ScrollRelative (Vec2I v)
params v The relative amount to scroll.

Scrolls by the given relative amount.

method ScrollRelative (int32 x, int32 y)
params x The relative X-amount to scroll.
  y The relative Y-amount to scroll.

ScrollTo

Scrolls to the given absolute position.

method ScrollTo (Vec2I v)
params v The absolute position to scroll to.

Scrolls to the given absolute position.

method ScrollTo (int32 x, int32 y)
params x The absolute X-position to scroll to.
  y The absolute Y-position to scroll to.