Scrollable

Implement scrolling for the given node.

This only supports scrolling in one axis.

alias Scrollable(T : Space) = Scrollable!(T, "directionHorizontal")
class Scrollable(T : Node, string horizontalExpression)
@safe
class Scrollable : T, FluidScrollable , HoverScrollable (
T : Node
string horizontalExpression
) {
HoverIO hoverIO;
ScrollInput scrollBar;
this(T args);
alias opEquals = Node.opEquals;
bool opEquals(Object other);
inout(float) scroll();
float scroll();
float scroll(float value);
void scrollStart();
void scrollEnd();
void setScroll(float value);
float scrollMax();
alias maxScroll = scrollMax;
Rectangle shallowScrollTo(Node child, Vector2 , Rectangle parentBox, Rectangle childBox);
Rectangle shallowScrollTo(Node , Rectangle parentBox, Rectangle childBox);
void resizeImpl(Vector2 space);
void drawImpl(Rectangle mainOuter, Rectangle inner);
bool canScroll(Vector2 valueVec);
void scrollImpl(Vector2 valueVec);
bool canScroll(HoverPointer pointer);
bool scrollImpl(HoverPointer pointer);
}

Constructors

this this(T args): Undocumented in source.

Members

Aliases

maxScroll alias maxScroll = scrollMax: Undocumented in source.
opEquals alias opEquals = Node.opEquals: Undocumented in source.

Functions

canScroll bool canScroll(Vector2 valueVec): Undocumented in source. Be warned that the author may not have intended to support it.
canScroll bool canScroll(HoverPointer pointer): Undocumented in source. Be warned that the author may not have intended to support it.
drawImpl void drawImpl(Rectangle mainOuter, Rectangle inner): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(Object other): Undocumented in source. Be warned that the author may not have intended to support it.
resizeImpl void resizeImpl(Vector2 space): Undocumented in source. Be warned that the author may not have intended to support it.
scroll inout(float) scroll(): Distance the node is scrolled by.
scroll float scroll(): Undocumented in source. Be warned that the author may not have intended to support it.
scroll float scroll(float value): Undocumented in source. Be warned that the author may not have intended to support it.
scrollEnd void scrollEnd(): Scroll to the end of the node, requires the node to be drawn at least once.
scrollImpl void scrollImpl(Vector2 valueVec): Undocumented in source. Be warned that the author may not have intended to support it.
scrollImpl bool scrollImpl(HoverPointer pointer): Undocumented in source. Be warned that the author may not have intended to support it.
scrollMax float scrollMax(): Get the maximum value this container can be scrolled to. Requires at least one draw.
scrollStart void scrollStart(): Scroll to the beginning of the node.
setScroll void setScroll(float value): Set the scroll to a value clamped between start and end.
shallowScrollTo deprecated Rectangle shallowScrollTo(Node child, Vector2 , Rectangle parentBox, Rectangle childBox): Undocumented in source. Be warned that the author may not have intended to support it.
shallowScrollTo Rectangle shallowScrollTo(Node , Rectangle parentBox, Rectangle childBox): Scroll to the given node.

Variables

hoverIO HoverIO hoverIO;: Undocumented in source.
scrollBar ScrollInput scrollBar;: Scrollbar for the frame. Can be replaced with a customized one.

Inherited Members

From FluidScrollable

canScroll bool canScroll(Vector2 value): Returns true if the node can react to given scroll.
scrollImpl void scrollImpl(Vector2 value): React to scroll wheel input.
shallowScrollTo Rectangle shallowScrollTo(Node child, Rectangle parentBox, Rectangle childBox): Scroll to given child node.
scroll float scroll(): Get current scroll value.
scroll float scroll(float value): Set scroll value.

From HoverScrollable

canScroll bool canScroll(HoverPointer pointer): Determines whether this node can accept scroll input and if the input can have visible effect. This is usually determined by the node's position; for example a container node already scrolled to the bottom cannot accept further vertical movement down.
scrollImpl bool scrollImpl(HoverPointer pointer): Perform a scroll motion, moving the node's contents by the specified distance.
shallowScrollTo Rectangle shallowScrollTo(Node child, Rectangle parentBox, Rectangle childBox): Scroll towards a specified child node, trying to get it into view.
opEquals bool opEquals(Object other): Memory safe and const object comparison.

Scrollable

Constructors

Members

Aliases

Functions

Variables

Inherited Members

From FluidScrollable

From HoverScrollable

Meta

Source