ScrollWidgetBase

Abstract scrollable widget

Provides scroll bars and basic scrolling functionality.

class ScrollWidgetBase : WidgetGroup , OnScrollHandler {}

Constructors

this
this(string ID, ScrollBarMode hscrollbarMode, ScrollBarMode vscrollbarMode)
Undocumented in source.

Members

Functions

checkIfNeededToChangeScrollbarVisibility
void checkIfNeededToChangeScrollbarVisibility()
Undocumented in source. Be warned that the author may not have intended to support it.
checkIfScrollbarsNeeded
void checkIfScrollbarsNeeded(bool needHScroll, bool needVScroll)

override to determine if scrollbars are needed or not

drawClient
void drawClient(DrawBuf buf)
Undocumented in source. Be warned that the author may not have intended to support it.
drawExtendedArea
void drawExtendedArea(DrawBuf buf)
Undocumented in source. Be warned that the author may not have intended to support it.
fullContentSize
Point fullContentSize()

calculate full content size in pixels

fullContentSizeWithBorders
Point fullContentSizeWithBorders()

calculate full content size in pixels including widget borders / margins

handleClientRectLayout
void handleClientRectLayout(Rect rc)

override to support modification of client rect after change, e.g. apply offset

layout
void layout(Rect rc)

Set widget rectangle to specified value and layout widget contents. (Step 2 of two phase layout).

makeRectVisible
void makeRectVisible(Rect rc, bool alignHorizontally, bool alignVertically)
Undocumented in source. Be warned that the author may not have intended to support it.
measure
void measure(int parentWidth, int parentHeight)

Measure widget according to desired width and height constraints. (Step 1 of two phase layout).

minimumVisibleContentSize
Point minimumVisibleContentSize()
Undocumented in source. Be warned that the author may not have intended to support it.
onDraw
void onDraw(DrawBuf buf)

Draw widget at its position to buffer

onHScroll
bool onHScroll(ScrollEvent event)

process horizontal scrollbar event

onMouseEvent
bool onMouseEvent(MouseEvent event)

process mouse event; return true if event is processed by widget.

onScrollEvent
bool onScrollEvent(AbstractSlider source, ScrollEvent event)

handle scroll event

onVScroll
bool onVScroll(ScrollEvent event)

process vertical scrollbar event

updateHScrollBar
void updateHScrollBar()

update horizontal scrollbar widget position

updateScrollBars
void updateScrollBars()

update scrollbar positions

updateVScrollBar
void updateVScrollBar()

update verticat scrollbar widget position

Properties

clientRect
Rect clientRect [@property getter]

returns client area rectangle

hscrollbar
ScrollBar hscrollbar [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
hscrollbar
ScrollBar hscrollbar [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
hscrollbarMode
ScrollBarMode hscrollbarMode [@property getter]

horizontal scrollbar mode

hscrollbarMode
ScrollBarMode hscrollbarMode [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
vscrollbar
ScrollBar vscrollbar [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
vscrollbar
ScrollBar vscrollbar [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
vscrollbarMode
ScrollBarMode vscrollbarMode [@property getter]

vertical scrollbar mode

vscrollbarMode
ScrollBarMode vscrollbarMode [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.

Variables

_clientRect
Rect _clientRect;

inner area, excluding additional controls like scrollbars

_fullScrollableArea
Rect _fullScrollableArea;
Undocumented in source.
_hscrollbar
ScrollBar _hscrollbar;

horizontal scrollbar control

_hscrollbarMode
ScrollBarMode _hscrollbarMode;
Undocumented in source.
_insideChangeScrollbarVisibility
bool _insideChangeScrollbarVisibility;
Undocumented in source.
_visibleScrollableArea
Rect _visibleScrollableArea;
Undocumented in source.
_vscrollbar
ScrollBar _vscrollbar;

vertical scrollbar control

_vscrollbarMode
ScrollBarMode _vscrollbarMode;
Undocumented in source.

Inherited Members

From WidgetGroup

_children
WidgetList _children;
Undocumented in source.
needDraw
bool needDraw [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
childCount
int childCount [@property getter]

returns number of children of this widget

child
inout(Widget) child(int index)

returns child by index

addChild
Widget addChild(Widget item)

adds child, returns added item

insertChild
Widget insertChild(Widget item, int index)

inserts child at given index, returns inserted item

removeChild
Widget removeChild(int index)

removes child, returns removed item

removeChild
Widget removeChild(string ID)

removes child by ID, returns removed item

removeChild
Widget removeChild(Widget child)

removes child, returns removed item

childIndex
int childIndex(Widget item)

returns index of widget in child list, -1 if passed widget is not a child of this widget

removeAllChildren
void removeAllChildren(bool destroyObj)
Undocumented in source. Be warned that the author may not have intended to support it.
replaceChild
void replaceChild(Widget newChild, Widget oldChild)

replace child with other child

From OnScrollHandler

onScrollEvent
bool onScrollEvent(AbstractSlider source, ScrollEvent event)

handle scroll event

Meta