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 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

ScrollEvent, Events and Event Handling

Inheritance Diagram

Inheritance diagram for class ScrollWinEvent

Methods Summary

__init__	Constructor.
GetOrientation	Returns HORIZONTAL or VERTICAL, depending on the orientation of the scrollbar.
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 ScrollWinEvent(Event)

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

Possible constructors:

ScrollWinEvent(commandType=wxEVT_NULL, pos=0, orientation=0)

Methods

---

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

Constructor.

Parameters:

• commandType (EventType) –
• pos (int) –
• orientation (int) –

---

GetOrientation(self)

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

Return type:int

Todo

HORIZONTAL and VERTICAL should go in their own enum

---

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) –

---

SetPosition(self, pos)

Parameters:pos (int) –

Properties

---

Orientation

See GetOrientation and SetOrientation

---

Position

See GetPosition and SetPosition