Package wx :: Class ScrollWinEvent
[frames | no frames]

Type ScrollWinEvent

object --+        
         |        
    Object --+    
             |    
         Event --+
                 |
                ScrollWinEvent


A wx.ScrollWinEvent holds information about scrolling and is sent from scrolling windows.

Events

EVT_SCROLLWIN Used to bind all scrolled window scroll events
EVT_SCROLLWIN_TOP scroll-to-top events (minimum position)
EVT_SCROLLWIN_BOTTOM scroll-to-bottom events (maximum position)
EVT_SCROLLWIN_LINEUP line up events
EVT_SCROLLWIN_LINEDOWN line down events
EVT_SCROLLWIN_PAGEUP page up events
EVT_SCROLLWIN_PAGEDOWN page down events
EVT_SCROLLWIN_THUMBTRACK thumbtrack events (frequent events sent as the user drags the 'thumb')
EVT_SCROLLWIN_THUMBRELEASE thumb release events.
EVT_SCROLLWIN_ENDSCROLL End of scrolling

See Also:

wx.ScrollEvent

Method Summary
ScrollWinEvent __init__(self, commandType, pos, orient)
A wx.ScrollWinEvent holds information about scrolling and is sent from scrolling windows.
  __repr__(self)
int GetOrientation(self)
Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of the scrollbar.
int GetPosition(self)
Returns the position of the scrollbar for the thumb track and release events.
  SetOrientation(self, orient)
  SetPosition(self, pos)
    Inherited from Event
  __del__(self)
Event Clone(self)
Object GetEventObject(self)
Returns the object (usually a window) associated with the event, if any.
wxEventType GetEventType(self)
Returns the identifier of the given event type, such as wxEVT_COMMAND_BUTTON_CLICKED.
int GetId(self)
Returns the identifier associated with this event, such as a button command id.
bool GetSkipped(self)
Returns true if the event handler should be skipped, false otherwise.
long GetTimestamp(self)
bool IsCommandEvent(self)
Returns true if the event is or is derived from wx.CommandEvent else it returns false.
  ResumePropagation(self, propagationLevel)
Resume the event propagation by restoring the propagation level.
  SetEventObject(self, obj)
Sets the originating object, or in other words, obj is normally the object that is sending the event.
  SetEventType(self, typ)
Sets the specific type of the event.
  SetId(self, Id)
Set's the ID for the event.
  SetTimestamp(self, ts)
bool ShouldPropagate(self)
Test if this event should be propagated to the parent window or not, i.e.
  Skip(self, skip)
Called by an event handler, it controls whether additional event handlers bound to this event will be called after the current event handler returns.
int StopPropagation(self)
Stop the event from propagating to its parent window.
    Inherited from Object
  Destroy(self)
Deletes the C++ object this Python object is a proxy for.
String GetClassName(self)
Returns the class name of the C++ class using wxRTTI.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
Return hash(x)...
  __new__(T, S, ...)
Return a new object with type S, a subtype of T...
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
Return str(x)...

Method Details

__init__(self, commandType=wxEVT_NULL, pos=0, orient=0)
(Constructor)

A wx.ScrollWinEvent holds information about scrolling and is sent from scrolling windows.

Events

EVT_SCROLLWIN Used to bind all scrolled window scroll events
EVT_SCROLLWIN_TOP scroll-to-top events (minimum position)
EVT_SCROLLWIN_BOTTOM scroll-to-bottom events (maximum position)
EVT_SCROLLWIN_LINEUP line up events
EVT_SCROLLWIN_LINEDOWN line down events
EVT_SCROLLWIN_PAGEUP page up events
EVT_SCROLLWIN_PAGEDOWN page down events
EVT_SCROLLWIN_THUMBTRACK thumbtrack events (frequent events sent as the user drags the 'thumb')
EVT_SCROLLWIN_THUMBRELEASE thumb release events.
EVT_SCROLLWIN_ENDSCROLL End of scrolling
Parameters:
commandType
           (type=wxEventType)

pos
           (type=int)

orient
           (type=int)

Returns:
ScrollWinEvent
Overrides:
wx.Event.__init__

See Also:

wx.ScrollEvent

GetOrientation(self)

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

Returns:
int

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.

Returns:
int

Generated by Epydoc 2.1.20050511.rpd on Sat Jun 16 16:46:53 2007 http://epydoc.sf.net