wScrollBar

A wScrollBar is a control that represents a horizontal or vertical scrollbar.

Appearance:
Superclass:wControl
Styles:
StylesDescription
wSbHorizontalSpecifies a horizontal scrollbar.
wSbVerticalSpecifies a vertical scrollbar.
Events:wScrollEvent

Consts

wSbHorizontal = 0x00000000
wSbVertical = 0x00000001

Procs

proc isVertical(self: wScrollBar): bool {...}{.inline, raises: [], tags: [].}
Returns true for scrollbars that have the vertical style set.
proc setScrollbar(self: wScrollBar; position: Natural; pageSize: Positive;
                 range: Positive) {...}{.raises: [], tags: [].}
Sets the scrollbar properties.
proc setScrollPos(self: wScrollBar; position: int) {...}{.raises: [], tags: [].}
Sets the position of the scrollbar.
proc getPageSize(self: wScrollBar): int {...}{.inline, raises: [], tags: [].}
Returns the page size.
proc getRange(self: wScrollBar): int {...}{.inline, raises: [], tags: [].}
Returns the length of the scrollbar.
proc getScrollPos(self: wScrollBar): int {...}{.inline, raises: [], tags: [].}
Returns the current position of the scrollbar.
proc init(self: wScrollBar; parent: wWindow; id = wDefaultID; pos = wDefaultPoint;
         size = wDefaultSize; style: wStyle = 0) {...}{.raises: [wNilAccess, wWindowError,
    wCursorError, wBrushError, Exception, IndexDefect, wFontError],
    tags: [RootEffect].}
Initializes a scrollbar.
proc ScrollBar(parent: wWindow; id = wDefaultID; pos = wDefaultPoint;
              size = wDefaultSize; style: wStyle = 0): wScrollBar {...}{.inline, discardable, raises: [
    wNilAccess, wWindowError, wCursorError, wBrushError, Exception, IndexDefect,
    wFontError], tags: [RootEffect].}
Constructor.

Methods

method getDefaultSize(self: wScrollBar): wSize {...}{.raises: [], tags: [].}
Returns the default size for the control.
method getBestSize(self: wScrollBar): wSize {...}{.raises: [], tags: [].}
Returns the best acceptable minimal size for the control.
method release(self: wScrollBar) {...}{.raises: [], tags: [RootEffect].}
Release all the resources during destroying. Used internally.