Class: TScrollRequestor

Declaration: ScrollRequestor.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

TScrollRequestor allows you to programmatically scroll a content view within a TScrolling view.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive from TScrollRequestor.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TScrollRequestor::TScrollRequestor

TScrollRequestor ()
TScrollRequestor (TView * viewToScrollAlias)
TScrollRequestor (const TScrollRequestor &)

Interface Category:

API.

Purpose:

Default constructor.
Creates a scroll requestor for the specified view.
Copy constructor.

Calling Context:

Called to create a TScrollRequestor suitable for streaming into.
Called to create a scroll requestor for the specified view.
Called to copy an object.

Parameters:

Takes no parameters.
TView * viewToScrollAlias -The view to be scrolled.
const TScrollRequestor & -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrollRequestor::~TScrollRequestor

virtual ~ TScrollRequestor ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrollRequestor::operator=

virtual TScrollRequestor & operator =(const TScrollRequestor &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TScrollRequestor & -The object to be copied.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrollRequestor::operator>>=

virtual TStream & operator >>=(TStream &) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & -The destination stream.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrollRequestor::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & -The source stream.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws TInvalidVersionError if the version of the flattened object is not the original version.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrollRequestor::VerticalUnitScroll

virtual void VerticalUnitScroll (signed long lines)

Interface Category:

API.

Purpose:

Scrolls the view vertically by the number of lines specified.

Calling Context:

Call this function directly to scroll the view vertically.

Parameters:

signed long lines -The number of lines to scroll.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrollRequestor::HorizontalUnitScroll

virtual void HorizontalUnitScroll (signed long units)

Interface Category:

API.

Purpose:

Scrolls the view horizontally by the number of units specified.

Calling Context:

Call this function directly to scroll the view horizontally.

Parameters:

signed long units -The number of units to scroll.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrollRequestor::VerticalPageScroll

virtual void VerticalPageScroll (signed long pages)

Interface Category:

API.

Purpose:

Pages the view upward or downward.

Calling Context:

Call this function directly to page the view upward or downward.

Parameters:

signed long pages -The number of pages to scroll. If the number is negative the view is scrolled upward. If the number is positive, the view is scrolled downward.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrollRequestor::HorizontalPageScroll

virtual void HorizontalPageScroll (signed long pages)

Interface Category:

API.

Purpose:

Pages the view left or right.

Calling Context:

Call this function directly to page the view left or right.

Parameters:

signed long pages -The number of pages to scroll. If the number is negative the view is scrolled left. If the number is positive, the view is scrolled right.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrollRequestor::HomeScroll

virtual void HomeScroll ()

Interface Category:

API.

Purpose:

Scrolls the view to the home position.

Calling Context:

Call this function directly to scroll the view to the home position.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrollRequestor::EndScroll

virtual void EndScroll ()

Interface Category:

API.

Purpose:

Scrolls the view to the end position.

Calling Context:

Call this function directly to scroll the view to the end position.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrollRequestor::PositionScrolledViewPoint

virtual void PositionScrolledViewPoint (const TGPoint & scrolledViewLocalPoint, const TGPoint & clipLocalPoint)

Interface Category:

API.

Purpose:

Scrolls the view such that the points scrolledViewLocalPoint and clipLocalPoint are aligned.

Calling Context:

Call this function directly to scroll the view such that scrolledViewLocalPoint and clipLocalPoint are aligned.

Parameters:

const TGPoint & scrolledViewLocalPoint -Point given in the content view's coordinate system.
const TGPoint & clipLocalPoint -Point given in the scrolling view's coordinate system.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrollRequestor::MakeScrolledViewRectVisible

virtual void MakeScrolledViewRectVisible (const TGRect & criticalRect, const TGRect & proximityRect =TGRect :: kInfiniteRect)

Interface Category:

API.

Purpose:

Attempts to make proximityRect visible if it is not the infinite rectangle and it contains the criticalRect. If any of these conditions are not met or if the attempt fails, then an attempt is made to make the critical rect visible. If neither rectangle can be made visible, then this function aligns the closest corresponding corners of the criticalRect and the clipping rectangle, using the PositionScrolledViewPoint member function.

Calling Context:

Call this function directly to make scrolled view visible when an user types or selects beyond the bounds of a clipped area.

Parameters:

const TGRect & criticalRect -The critical rectangle.
const TGRect & proximityRect =TGRect :: kInfiniteRect -The proximity rectangle.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.