1wxScrollEvent(3)           Erlang Module Definition           wxScrollEvent(3)
2
3
4

NAME

6       wxScrollEvent - Functions for wxScrollEvent class
7

DESCRIPTION

9       A  scroll  event  holds  information about events sent from stand-alone
10       scrollbars (see wxScrollBar) and sliders (see wxSlider).
11
12       Note that scrolled windows send the wxScrollWinEvent which does not de‐
13       rive  from  wxCommandEvent,  but  from wxEvent directly - don't confuse
14       these two kinds of events and use the event table macros mentioned  be‐
15       low only for the scrollbar-like controls.
16
17       The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED
18
19       The  EVT_SCROLL_THUMBRELEASE  event is only emitted when actually drag‐
20       ging the thumb using the mouse and releasing it (This  EVT_SCROLL_THUM‐
21       BRELEASE event is also followed by an EVT_SCROLL_CHANGED event).
22
23       The  EVT_SCROLL_CHANGED  event  also  occurs when using the keyboard to
24       change the thumb position, and when clicking next to the thumb (In  all
25       these cases the EVT_SCROLL_THUMBRELEASE event does not happen).
26
27       In  short,  the  EVT_SCROLL_CHANGED  event is triggered when scrolling/
28       moving has finished independently of the way it had started. Please see
29       the  page_samples_widgets ("Slider" page) to see the difference between
30       EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED in action.
31
32       Remark: Note that unless specifying a scroll  control  identifier,  you
33       will  need  to  test  for  scrollbar orientation with getOrientation/1,
34       since horizontal and vertical scroll events  are  processed  using  the
35       same event handler.
36
37       See:  wxScrollBar,  wxSlider,  wxSpinButton, wxScrollWinEvent, Overview
38       events
39
40       This class is derived (and can use functions) from: wxCommandEvent  wx‐
41       Event
42
43       wxWidgets docs: wxScrollEvent
44

EVENTS

46       Use  wxEvtHandler:connect/3  with  wxScrollEventType  to  subscribe  to
47       events of this type.
48

DATA TYPES

50       wxScrollEvent() = wx:wx_object()
51
52       wxScroll() =
53           #wxScroll{type = wxScrollEvent:wxScrollEventType(),
54                     commandInt = integer(),
55                     extraLong = integer()}
56
57       wxScrollEventType() =
58           scroll_top | scroll_bottom | scroll_lineup | scroll_linedown |
59           scroll_pageup | scroll_pagedown | scroll_thumbtrack |
60           scroll_thumbrelease | scroll_changed
61

EXPORTS

63       getOrientation(This) -> integer()
64
65              Types:
66
67                 This = wxScrollEvent()
68
69              Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation
70              of the scrollbar.
71
72       getPosition(This) -> integer()
73
74              Types:
75
76                 This = wxScrollEvent()
77
78              Returns the position of the scrollbar.
79
80
81
82wxWidgets team.                     wx 2.1                    wxScrollEvent(3)