ICnrScrollEvent

The ICnrScrollEvent class retrieves information about a container scroll event. Objects of this class are dispatched when scrolling is requested in the container. These events are created in response to a notification from the container that one of the container's windows has been scrolled.

AIX Considerations

The Motif container widget do not support scroll notification. This event is not dispatched in AIX.

Windows Considerations

The native Windows containers (that is, containers constructed without the pmCompatible style) do not support scroll notification. This event is not used in this case.


ICnrScrollEvent - Member Functions and Data by Group

Constructors & Destructor

You can construct and destruct objects of this class.


[view class]
~ICnrScrollEvent
public:
virtual ~ICnrScrollEvent()

Supported Platforms

Windows OS/2 AIX
Yes Yes Ignored


[view class]
ICnrScrollEvent
public:
ICnrScrollEvent(const IControlEvent& event)

Although you can construct objects of this class, typically ICnrHandler::dispatchHandlerEvent creates objects of this class from an object of the class IControlEvent in response to a notification from the container that one of the container's windows has been scrolled.

Supported Platforms

Windows OS/2 AIX
Yes Yes Ignored


Event Information

Use these members to query and set the accessible attributes of this class.


[view class]
amount
public:
long amount() const

Returns the amount the window has scrolled, in pixels.

Supported Platforms

Windows OS/2 AIX
Yes Yes Ignored


[view class]
isHorizontal
public:
bool isHorizontal() const

If scrolling in the horizontal direction, true is returned.

Supported Platforms

Windows OS/2 AIX
Yes Yes Ignored


[view class]
isLeftDetails
public:
bool isLeftDetails() const

If the scrolling occurred in the left (or only) side of the details view, true is returned.

Supported Platforms

Windows OS/2 AIX
Yes Yes Ignored


[view class]
isRightDetails
public:
bool isRightDetails() const

If the scrolling occurred in the right side of a split details view, true is returned.

Supported Platforms

Windows OS/2 AIX
Yes Yes Ignored


[view class]
isVertical
public:
bool isVertical() const

If scrolling occurred in the vertical direction, true is returned.

Supported Platforms

Windows OS/2 AIX
Yes Yes Ignored


ICnrScrollEvent - Inherited Member Functions and Data

Inherited Public Functions

ICnrEvent
IControlEvent
IEvent

Inherited Public Data

Inherited Protected Functions

ICnrEvent

Inherited Protected Data