wx.ScrollWinEvent

A scroll event holds information about events sent from scrolling windows.

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

Events Emitted by this Class

Handlers bound for the following event types will receive a wx.ScrollWinEvent parameter.

• EVT_SCROLLWIN: Process all scroll events.

• EVT_SCROLLWIN_TOP: Process wxEVT_SCROLLWIN_TOP scroll-to-top events.

• EVT_SCROLLWIN_BOTTOM: Process wxEVT_SCROLLWIN_BOTTOM scroll-to-bottom events.

• EVT_SCROLLWIN_LINEUP: Process wxEVT_SCROLLWIN_LINEUP line up events.

• EVT_SCROLLWIN_LINEDOWN: Process wxEVT_SCROLLWIN_LINEDOWN line down events.

• EVT_SCROLLWIN_PAGEUP: Process wxEVT_SCROLLWIN_PAGEUP page up events.

• EVT_SCROLLWIN_PAGEDOWN: Process wxEVT_SCROLLWIN_PAGEDOWN page down events.

• EVT_SCROLLWIN_THUMBTRACK: Process wxEVT_SCROLLWIN_THUMBTRACK thumbtrack events (frequent events sent as the user drags the thumbtrack).

• EVT_SCROLLWIN_THUMBRELEASE: Process wxEVT_SCROLLWIN_THUMBRELEASE thumb release events.

See also

wx.ScrollEvent, Events and Event Handling

Class Hierarchy

Inheritance diagram for class ScrollWinEvent:

Methods Summary

__init__	Constructor.
GetOrientation	Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of the scrollbar.
GetPixelOffset	Offset of the scroll position from the nearest position expressed in scroll units.
GetPosition	Returns the position of the scrollbar for the thumb track and release events.
SetOrientation
SetPosition

Properties Summary

Orientation	See GetOrientation and SetOrientation
Position	See GetPosition and SetPosition

Class API

class wx.ScrollWinEvent(Event)

Possible constructors:

ScrollWinEvent(commandType=wxEVT_NULL, pos=0, orientation=0) -> None

A scroll event holds information about events sent from scrolling windows.

Methods

__init__(self, commandType=wxEVT_NULL, pos=0, orientation=0)

Constructor.

Parameters:

• commandType (wx.EventType)

• pos (int)

• orientation (int)

Return type:

None

---

GetOrientation(self)

Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of the scrollbar.

Return type:

int

Todo

wx.HORIZONTAL and wx.VERTICAL should go in their own enum

---

GetPixelOffset(self)

Offset of the scroll position from the nearest position expressed in scroll units.

In cases where scrolling is possible with single pixel precision, such as when panning on a touch screen with fingers, this returns the offset in pixels of the real position compared to the position obtained by multiplying the current scroll position in scroll units by the size of scroll unit in pixels. For example, if the scroll unit size (pixels per line) is 20px, this function returns a value which can be between 0 and 19.

Return type:

int

Added in version 4.2/wxWidgets-3.2.2.

---

GetPosition(self)

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.

Return type:

int

---

SetOrientation(self, orient)

Parameters:

orient (int)

Return type:

None

---

SetPosition(self, pos)

Parameters:

pos (int)

Return type:

None

Properties

Orientation

See GetOrientation and SetOrientation

---

Position

See GetPosition and SetPosition