LKeyScrollAttachment

LKeyScrollAttachment is a PowerPlant class that is used for handling scrolling of a View using the Home, End, PageUp, or PageDown keyboard navigation keys.

Methods :

The methods in this class are:

LKeyScrollAttachment()

ExecuteSelf()

Data Members:

The data members in this class are:

mViewToScroll

Operation:

This class is for use only with msg_KeyPress.If you have a View that is also a Commander, you can attach a LKeyScrollAttachment to it to implement keyboard navigation.

If your View is not a Commander, but you still want to implement keyboard navigation, you can attach a LKeyScrollAttachment to a SuperView that is a Commander (such as the Window containing the View). However, if you can delete the View independent of the Window, you must take care to delete the Attachment.

Source files:

(Utility Classes)

UAttachments.h

UAttachments.cp

See also:

LAttachment

LCommander

LPane

LView

LWindow

LKeyScrollAttachment()

Purpose:

The constructor creates the object using the passed-in parameters.

Access:

Public

Prototype:

LKeyScrollAttachment( LView *inViewToScroll );

LKeyScrollAttachment( LStream *inStream );

The parameters for these constructors are:

LView*	inViewToScroll	A pointer to a LView to set mViewToScroll to.
LStream*	inStream	A pointer to a stream object that contains the information to create the LBorderAttachment object.

ExecuteSelf()

Purpose:

This method handles keyboard navigation scrolling. If the key that is passed to this method via ioParam is not Home, End, PageUp, or PageDown, then mExecuteHost will be set to true, else it is set to false. If true, this indicates that the host should handle the key event. This is an override of ExecuteSelf() in LAttachment.

mViewToScroll

Purpose:

A pointer to a LView that we want to scroll using keyboard navigational keys.

Access:

Protected

Prototype:

LView *mViewToScroll;