Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

wxScrollWinEvent (3erl)

Name

wxScrollWinEvent - Functions for wxScrollWinEvent class

Synopsis

Please see following description for synopsis

Description

wxScrollWinEvent(3)        Erlang Module Definition        wxScrollWinEvent(3)



NAME
       wxScrollWinEvent - Functions for wxScrollWinEvent class

DESCRIPTION
       A  scroll event holds information about events sent from scrolling win-
       dows.

       Note that you can use the EVT_SCROLLWIN* macros for intercepting scroll
       window events from the receiving window.

       See: wxScrollEvent, Overview events

       This class is derived (and can use functions) from: wxEvent

       wxWidgets docs: wxScrollWinEvent

EVENTS
       Use  wxEvtHandler:connect/3  with  wxScrollWinEventType to subscribe to
       events of this type.

DATA TYPES
       wxScrollWinEvent() = wx:wx_object()

       wxScrollWin() =
           #wxScrollWin{type = wxScrollWinEvent:wxScrollWinEventType(),
                        commandInt = integer(),
                        extraLong = integer()}

       wxScrollWinEventType() =
           scrollwin_top | scrollwin_bottom | scrollwin_lineup |
           scrollwin_linedown | scrollwin_pageup | scrollwin_pagedown |
           scrollwin_thumbtrack | scrollwin_thumbrelease

EXPORTS
       getOrientation(This) -> integer()

              Types:

                 This = wxScrollWinEvent()

              Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation
              of the scrollbar.

       getPosition(This) -> integer()

              Types:

                 This = wxScrollWinEvent()

              Returns  the  position  of the scrollbar for the thumb track and
              release events.

              Note that this field can't be used for  the  other  events,  you
              need to query the window itself for the current position in that
              case.



wxWidgets team.                    wx 2.1.1                wxScrollWinEvent(3)