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 {...}{.validate, inline, raises: [], tags: [].}
Returns true for scrollbars that have the vertical style set.
proc setScrollbar(self: wScrollBar; position: Natural; pageSize: Positive;
                 range: Positive) {...}{.validate, property, raises: [], tags: [].}
Sets the scrollbar properties.
proc setScrollPos(self: wScrollBar; position: int) {...}{.validate, property, raises: [],
    tags: [].}
Sets the position of the scrollbar.
proc getPageSize(self: wScrollBar): int {...}{.validate, property, inline, raises: [],
                                      tags: [].}
Returns the page size.
proc getRange(self: wScrollBar): int {...}{.validate, property, inline, raises: [], tags: [].}
Returns the length of the scrollbar.
proc getScrollPos(self: wScrollBar): int {...}{.validate, property, inline, raises: [],
                                       tags: [].}
Returns the current position of the scrollbar.
proc final(self: wScrollBar) {...}{.raises: [], tags: [].}
Default finalizer for wScrollBar.
proc init(self: wScrollBar; parent: wWindow; id = wDefaultID; pos = wDefaultPoint;
         size = wDefaultSize; style: wStyle = 0) {...}{.validate, raises: [], tags: [].}
Initializer.
proc ScrollBar(parent: wWindow; id = wDefaultID; pos = wDefaultPoint;
              size = wDefaultSize; style: wStyle = 0): wScrollBar {...}{.inline, discardable,
    raises: [], tags: [].}
Constructor, creating and showing a scrollbar.

Methods

method getDefaultSize(self: wScrollBar): wSize {...}{.property, raises: [], tags: [].}
Returns the default size for the control.
method getBestSize(self: wScrollBar): wSize {...}{.property, raises: [], tags: [].}
Returns the best acceptable minimal size for the control.