.TH wxScrollEvent 3erl "wx 2.4.1" "wxWidgets team." "Erlang Module Definition"
.SH NAME
wxScrollEvent \- Functions for wxScrollEvent class
.SH DESCRIPTION
.LP
A scroll event holds information about events sent from stand-alone scrollbars (see \fIwxScrollBar\fR\&) and sliders (see \fIwxSlider\fR\&)\&.
.LP
Note that scrolled windows send the \fIwxScrollWinEvent\fR\& which does not derive from \fIwxCommandEvent\fR\&, but from \fIwxEvent\fR\& directly - don\&'t confuse these two kinds of events and use the event table macros mentioned below only for the scrollbar-like controls\&.
.LP
The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED
.LP
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)\&.
.LP
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)\&.
.LP
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\&.
.LP
Remark: Note that unless specifying a scroll control identifier, you will need to test for scrollbar orientation with \fIgetOrientation/1\fR\&, since horizontal and vertical scroll events are processed using the same event handler\&.
.LP
See: \fIwxScrollBar\fR\&, \fIwxSlider\fR\&, \fIwxSpinButton\fR\&, \fIwxScrollWinEvent\fR\&, Overview events 
.LP
This class is derived (and can use functions) from: \fIwxCommandEvent\fR\& \fIwxEvent\fR\&
.LP
wxWidgets docs: wxScrollEvent
.SH "EVENTS"

.LP
Use \fIwxEvtHandler:connect/3\fR\& with \fIwxScrollEventType\fR\& to subscribe to events of this type\&.
.SH DATA TYPES
.nf

\fBwxScrollEvent()\fR\& = wx:wx_object()
.br
.fi
.nf

\fBwxScroll()\fR\& = 
.br
    #wxScroll{type = wxScrollEvent:wxScrollEventType(),
.br
              commandInt = integer(),
.br
              extraLong = integer()}
.br
.fi
.nf

\fBwxScrollEventType()\fR\& = 
.br
    scroll_top | scroll_bottom | scroll_lineup | scroll_linedown |
.br
    scroll_pageup | scroll_pagedown | scroll_thumbtrack |
.br
    scroll_thumbrelease | scroll_changed
.br
.fi
.SH EXPORTS
.LP
.nf

.B
getOrientation(This) -> integer()
.br
.fi
.br
.RS
.LP
Types:

.RS 3
This = wxScrollEvent()
.br
.RE
.RE
.RS
.LP
Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the scrollbar\&.
.RE

.LP
.nf

.B
getPosition(This) -> integer()
.br
.fi
.br
.RS
.LP
Types:

.RS 3
This = wxScrollEvent()
.br
.RE
.RE
.RS
.LP
Returns the position of the scrollbar\&.
.RE