The IScrollEvent class represents a scroll event for an IScrollBar object. This event is a notification for interactions with an IScrollBar object. An IScrollHandler object creates an IScrollEvent object and passes the event to one of its virtual functions for processing.
Constructors & DestructorYou can construct and destruct objects of this class.
![]() |
public:
virtual ~IScrollEvent()
| Windows | OS/2 | AIX |
| Yes | Yes | Yes |
![]() |
public:
IScrollEvent(const IEvent& event)
Although you can construct objects of this class, typically IScrollHandler::dispatchHandlerEvent creates objects of this class from an object of the class IEvent.
| Windows | OS/2 | AIX |
| Yes | Yes | Yes |
Event InformationUse these members to query information related to the scroll event.
![]() |
public:
unsigned long newScrollBoxPosition() const
Returns the new position of the scroll box. This is valid only for a scroll event passed to IScrollHandler::scrollBoxTrack or IScrollHandler::scrollBoxTrackEnd.
| IInvalidRequest | This event is invalid for this function. |
| Windows | OS/2 | AIX |
| Yes | Yes | Yes |
![]() |
public:
long scrollAmount() const
Returns the number of units that the scroll event wants the scroll box to scroll. If a backward scroll event occurs, a negative value is returned.
| IInvalidRequest | The scroll type is unknown; therefore, the distance scrolled cannot be determined. |
| Windows | OS/2 | AIX |
| Yes | Yes | Yes |
![]() |
public:
IScrollBar* scrollBarWindow() const
Returns a pointer to the IScrollBar object that the scroll event applies to.
| Windows | OS/2 | AIX |
| Yes | Yes | Yes |
This function throws an IInvalidRequest exception if the window is not a derived class of XmScrollBar (an IScrollBar).
virtual ~IEvent()
IWindowHandle controlHandle() const
virtual IWindow* controlWindow() const
IEvent& decrementOwnerLevels()
virtual IWindow* dispatchingWindow() const
unsigned long eventId() const
IWindowHandle handle() const
IEvent( IWindow* window, unsigned long eventId, const IEventParameter1& parameter1, const IEventParameter2& parameter2 )
IEvent( const IWindowHandle& handle, unsigned long eventId, const IEventParameter1& parameter1, const IEventParameter2& parameter2 )
IEvent(const IEvent& event)
IEvent& operator =(const IEvent& event)
IEventParameter1 parameter1() const
IEventParameter2 parameter2() const
bool passToOwner() const
IEventResult result() const
IEvent& setControlHandle(const IWindowHandle& handle)
IEvent& setDispatchingHandle(const IWindowHandle& handle)
IEvent& setDispatchingWindow(IWindow* window)
IEvent& setHandle(const IWindowHandle& handle)
IEvent& setNumberOfLevels(int levels = - 1)
IEvent& setPassToOwner(bool passOn = true)
IEvent& setResult(bool eventResult)
IEvent& setResult(const IEventResult& eventResult)
virtual IWindow* window() const