wxScrollBar.3erl - Man Page

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

It is distinct from the two scrollbars that some windows provide automatically, but the two types of scrollbar share the way events are received.

Remark: A scrollbar has the following main attributes: range, thumb size, page size, and position. The range is the total number of units associated with the view represented by the scrollbar. For a table with 15 columns, the range would be 15. The thumb size is the number of units that are currently visible. For the table example, the window might be sized so that only 5 columns are currently visible, in which case the application would set the thumb size to 5. When the thumb size becomes the same as or greater than the range, the scrollbar will be automatically hidden on most platforms. The page size is the number of units that the scrollbar should scroll by, when 'paging' through the data. This value is normally the same as the thumb size length, because it is natural to assume that the visible window size defines a page. The scrollbar position is the current thumb position. Most applications will find it convenient to provide a function called AdjustScrollbars() which can be called initially, from an OnSize event handler, and whenever the application data changes in size. It will adjust the view, object and page size according to the size of the window and the size of the data.

Styles

This class supports the following styles:

The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED

The EVT_SCROLL_THUMBRELEASE event is only emitted when actually dragging the thumb using the mouse and releasing it (This EVT_SCROLL_THUMBRELEASE event is also followed by an EVT_SCROLL_CHANGED event).

The EVT_SCROLL_CHANGED event also occurs when using the keyboard to change the thumb position, and when clicking next to the thumb (In all these cases the EVT_SCROLL_THUMBRELEASE event does not happen).

In short, the EVT_SCROLL_CHANGED event is triggered when scrolling/moving has finished independently of the way it had started. Please see the page_samples_widgets ("Slider" page) to see the difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED in action.

See: Overview scrolling, Overview events, wxScrolled (not implemented in wx)

This class is derived (and can use functions) from: wxControl wxWindow wxEvtHandler

wxWidgets docs: wxScrollBar

Event types emitted from this class: scroll_top, scroll_bottom, scroll_lineup, scroll_linedown, scroll_pageup, scroll_pagedown, scroll_thumbtrack, scroll_thumbrelease, scroll_changed, scroll_top, scroll_bottom, scroll_lineup, scroll_linedown, scroll_pageup, scroll_pagedown, scroll_thumbtrack, scroll_thumbrelease, scroll_changed

wxScrollBar() = wx:wx_object()

new() -> wxScrollBar()

new(Parent, Id) -> wxScrollBar()

Types:

Parent = wxWindow:wxWindow()
Id = integer()

new(Parent, Id, Options :: [Option]) -> wxScrollBar()

Types:

Parent = wxWindow:wxWindow()
Id = integer()
Option =
   {pos, {X :: integer(), Y :: integer()}} |
   {size, {W :: integer(), H :: integer()}} |
   {style, integer()} |
   {validator, wx:wx_object()}

destroy(This :: wxScrollBar()) -> ok

create(This, Parent, Id) -> boolean()

Types:

This = wxScrollBar()
Parent = wxWindow:wxWindow()
Id = integer()

create(This, Parent, Id, Options :: [Option]) -> boolean()

Types:

This = wxScrollBar()
Parent = wxWindow:wxWindow()
Id = integer()
Option =
   {pos, {X :: integer(), Y :: integer()}} |
   {size, {W :: integer(), H :: integer()}} |
   {style, integer()} |
   {validator, wx:wx_object()}

getRange(This) -> integer()

Types:

This = wxScrollBar()

getPageSize(This) -> integer()

Types:

This = wxScrollBar()

getThumbPosition(This) -> integer()

Types:

This = wxScrollBar()

getThumbSize(This) -> integer()

Types:

This = wxScrollBar()

setThumbPosition(This, ViewStart) -> ok

Types:

This = wxScrollBar()
ViewStart = integer()

setScrollbar(This, Position, ThumbSize, Range, PageSize) -> ok

Types:

This = wxScrollBar()
Position = ThumbSize = Range = PageSize = integer()

setScrollbar(This, Position, ThumbSize, Range, PageSize,
             Options :: [Option]) ->
                ok

Types:

This = wxScrollBar()
Position = ThumbSize = Range = PageSize = integer()
Option = {refresh, boolean()}