ScrollWidget

Widget which can show content of widget group with optional scrolling

If size of content widget exceeds available space, allows to scroll it.

Constructors

this
this()

empty parameter list constructor - for usage by factory

this
this(string ID, ScrollBarMode hscrollbarMode, ScrollBarMode vscrollbarMode)

create with ID parameter

Members

Functions

drawClient
void drawClient(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

makeWidgetVisible
void makeWidgetVisible(Widget widget, bool alignHorizontally, bool alignVertically)
Undocumented in source. Be warned that the author may not have intended to support it.
onHScroll
bool onHScroll(ScrollEvent event)

process horizontal scrollbar event

onVScroll
bool onVScroll(ScrollEvent event)

process vertical scrollbar event

scrollTo
void scrollTo(int x, int y)
Undocumented in source. Be warned that the author may not have intended to support it.
updateScrollBars
void updateScrollBars()

update scrollbar positions

Properties

contentWidget
Widget contentWidget [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
contentWidget
Widget contentWidget [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
scrollPos
Point scrollPos [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.

Variables

_contentWidget
Widget _contentWidget;
Undocumented in source.

Inherited Members

From ScrollWidgetBase

_vscrollbarMode
ScrollBarMode _vscrollbarMode;
Undocumented in source.
_hscrollbarMode
ScrollBarMode _hscrollbarMode;
Undocumented in source.
_vscrollbar
ScrollBar _vscrollbar;

vertical scrollbar control

_hscrollbar
ScrollBar _hscrollbar;

horizontal scrollbar control

_clientRect
Rect _clientRect;

inner area, excluding additional controls like scrollbars

_fullScrollableArea
Rect _fullScrollableArea;
Undocumented in source.
_visibleScrollableArea
Rect _visibleScrollableArea;
Undocumented in source.
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.
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.
clientRect
Rect clientRect [@property getter]

returns client area rectangle

onHScroll
bool onHScroll(ScrollEvent event)

process horizontal scrollbar event

onVScroll
bool onVScroll(ScrollEvent event)

process vertical 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

updateScrollBars
void updateScrollBars()

update scrollbar positions

hscrollbar
ScrollBar hscrollbar [@property getter]
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.
hscrollbar
ScrollBar hscrollbar [@property setter]
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.
updateHScrollBar
void updateHScrollBar()

update horizontal scrollbar widget position

updateVScrollBar
void updateVScrollBar()

update verticat scrollbar widget position

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.
onDraw
void onDraw(DrawBuf buf)

Draw widget at its position to buffer

fullContentSize
Point fullContentSize()

calculate full content size in pixels

measure
void measure(int parentWidth, int parentHeight)

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

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.

Meta