ScrollInput

@safe

class ScrollInput : InputNode!Node {

mixin defineStyles!("backgroundStyle", q{ Style.init }, "pressStyle", q{ style }) ;

mixin implHoveredRect ;

mixin enableInputActions ;

enum scrollSpeed;

enum actionScrollSpeed;

bool horizontal;

size_t position;

size_t availableSpace;

size_t width;

bool _isPressed;

bool innerHovered;

double pageLength;

double scrollbarLength;

double handleLength;

Vector2 scrollbarPosition;

Vector2 grabPosition;

size_t startPosition;

this(Args args);

bool isPressed [@property getter];

void setScroll(ptrdiff_t value);

void setScroll(float value);

size_t scrollMax();

void resizeImpl(Vector2 space);

void drawImpl(Rectangle paddingBox, Rectangle contentBox);

inout(Style) pickStyle();

void mouseImpl();

void _scrollPage(FluidInputAction action);

void _scroll();

void emitChange(ptrdiff_t move);

size_t scrollPageLength();

}

Constructors

this this(Args args): Undocumented in source.

Members

Functions

_scroll void _scroll(): Undocumented in source. Be warned that the author may not have intended to support it.
_scrollPage void _scrollPage(FluidInputAction action): Undocumented in source. Be warned that the author may not have intended to support it.
drawImpl void drawImpl(Rectangle paddingBox, Rectangle contentBox): Undocumented in source. Be warned that the author may not have intended to support it.
emitChange void emitChange(ptrdiff_t move): Change the value and run the changed callback.
mouseImpl void mouseImpl(): Undocumented in source. Be warned that the author may not have intended to support it.
pickStyle inout(Style) pickStyle(): Undocumented in source. Be warned that the author may not have intended to support it.
resizeImpl void resizeImpl(Vector2 space): Set the total size of the scrollbar. Will always fill the available space in the target direction.
scrollMax size_t scrollMax(): Get the maximum value this container can be scrolled to. Requires at least one draw.
scrollPageLength size_t scrollPageLength(): Scroll page length used for pageUp and pageDown navigation.
setScroll void setScroll(ptrdiff_t value)
void setScroll(float value): Set the scroll to a value clamped between start and end. Doesn't trigger the changed event.

Manifest constants

actionScrollSpeed enum actionScrollSpeed;: Keyboard/gamepad scroll speed in pixels per event.
scrollSpeed enum scrollSpeed;: Mouse scroll speed; Pixels per event in FluidScrollable.

Mixins

__anonymous mixin defineStyles!("backgroundStyle", q{ Style.init }, "pressStyle", q{ style }): Styles defined by this node:
__anonymous mixin implHoveredRect: Undocumented in source.
__anonymous mixin enableInputActions: Undocumented in source.

Properties

isPressed bool isPressed [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.

Variables

_isPressed bool _isPressed;: True if the scrollbar is pressed.
availableSpace size_t availableSpace;: Available space to scroll.
grabPosition Vector2 grabPosition;: Position where the mouse grabbed the scrollbar.
handleLength double handleLength;: Length of the handle.
horizontal bool horizontal;: If true, the scrollbar will be horizontal.
innerHovered bool innerHovered;: If true, the inner part of the scrollbar is hovered.
pageLength double pageLength;: Page length as determined in drawImpl.
position size_t position;: Amount of pixels the page is scrolled down.
scrollbarLength double scrollbarLength;: Length of the scrollbar as determined in drawImpl.
scrollbarPosition Vector2 scrollbarPosition;: Position of the scrollbar on the screen.
startPosition size_t startPosition;: Start position of the mouse at the beginning of the grab.
width size_t width;: Width of the scrollbar.

Mixed In Members

From `mixin defineStyles!("backgroundStyle", q{ Style.init }, "pressStyle", q{ style })`

reloadStylesImpl void reloadStylesImpl(): Undocumented in source. Be warned that the author may not have intended to support it.
loadDefaultStyles void loadDefaultStyles(): Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation

fluid scroll_input aliases

classes

ScrollInput