Class: TStandardScrollCoordinator

Declaration: ScrollCoordinator.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TScrollCoordinator

Inherited By:

None.

Purpose:

TStandardScrollCoordinator provides standard scrolling behavior for common scrolling operations.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

You can derive classes from TStandardScrollCoordinator to provide client-specified scrolling behavior.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TStandardScrollCoordinator::TStandardScrollCoordinator

TStandardScrollCoordinator ()
TStandardScrollCoordinator (const TStandardScrollCoordinator &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called to create a TStandardScrollCoordinator suitable for streaming into.
Called to copy an object.

Parameters:

Takes no parameters.
const TStandardScrollCoordinator & -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: TStandardScrollCoordinator::~TStandardScrollCoordinator

virtual ~ TStandardScrollCoordinator ()

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: TStandardScrollCoordinator::operator=

TStandardScrollCoordinator & operator =(const TStandardScrollCoordinator &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TStandardScrollCoordinator & -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: TStandardScrollCoordinator::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 to which the object streams itself.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardScrollCoordinator::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 from which the object streams itself.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardScrollCoordinator::GetVerticalUnitScrollEffect

virtual TGPoint GetVerticalUnitScrollEffect (signed long lines, const TView & scrolledView, const TGRect & clippedRect)

Interface Category:

API.

Purpose:

Returns the size currently used as the vertical scroll unit.

Calling Context:

Call this function directly to obtain the size of the vertical scroll unit.

Parameters:

signed long lines -A multiplier to apply to the size of one unit scroll. Typically it is set to 1, but can be set higher for multi-line scrolling.
const TView & scrolledView -The view being scrolled.
const TGRect & clippedRect -The TScrollingView's clipping rectangle.

Return Value:

Returns the size currently used as the vertical scroll unit.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardScrollCoordinator::GetHorizontalUnitScrollEffect

virtual TGPoint GetHorizontalUnitScrollEffect (signed long lines, const TView & scrolledView, const TGRect & clippedRect)

Interface Category:

API.

Purpose:

Returns the size currently used as the horizontal scroll unit.

Calling Context:

Call this function directly to obtain the size of the horizontal scroll unit.

Parameters:

signed long lines -A multiplier to apply to the size of one unit scroll. Typically it is set to 1, but can be set higher for multi-line scrolling.
const TView & scrolledView -The view being scrolled.
const TGRect & clippedRect -The TScrollingView's clipping rectangle.

Return Value:

Returns the size currently used as the horizontal scroll unit.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardScrollCoordinator::GetVerticalPagingScrollEffect

virtual TGPoint GetVerticalPagingScrollEffect (signed long pages, const TView & scrolledView, const TGRect & clippedRect)

Interface Category:

API.

Purpose:

Returns the size of the vertical page scroll. Vertical page scrolls are caused by a click in a scroll bar's trough.

Calling Context:

Call this function directly to obtain the size of the vertical page scroll.

Parameters:

signed long pages -A multiplier to apply to the size of one unit scroll. Typically it is set to 1, but can be set higher for multipage scrolling.
const TView & scrolledView -The view being scrolled.
const TGRect & clippedRect -The TScrollingView's clipping rectangle.

Return Value:

Returns the size of the vertical page scroll.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardScrollCoordinator::GetHorizontalPagingScrollEffect

virtual TGPoint GetHorizontalPagingScrollEffect (signed long pages, const TView & scrolledView, const TGRect & clippedRect)

Interface Category:

API.

Purpose:

Returns the size of the horizontal page scroll. Horizontal page scrolls are caused by a click in a scroll bar's trough.

Calling Context:

Call this function directly to obtain the size of the horizontal page scroll.

Parameters:

signed long pages -A multiplier to apply to the size of one unit scroll. Typically it is set to 1, but can be set higher for multipage scrolling.
const TView & scrolledView -The view being scrolled.
const TGRect & clippedRect -The TScrollingView's clipping rectangle.

Return Value:

Returns the size of the horizontal page scroll.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardScrollCoordinator::GetHomeScrollEffect

virtual TGPoint GetHomeScrollEffect (const TView & viewToScroll, const TGRect & clippedRect)

Interface Category:

API.

Purpose:

Returns the the effect necessary to return the view to the home position. The upper-left corner of the scrolled view matches the upper-left corner of the clippedRect.

Calling Context:

Call this function directly to obtain the effect necessary to scroll the view to the home position.

Parameters:

const TView & viewToScroll -The view being scrolled.
const TGRect & clippedRect -The TScrollingView's clipping rectangle.

Return Value:

Returns the the effect necessary to return the view to the home position.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardScrollCoordinator::GetEndScrollEffect

virtual TGPoint GetEndScrollEffect (const TView & viewToScroll, const TGRect & clippedRect)

Interface Category:

API.

Purpose:

Returns the the effect necessary to return the view to the end position. The bottom-left corner of the scrolled view matches the bottom-left corner of the clippedRect.

Calling Context:

Call this function directly to obtain the effect necessary to scroll the view to the end position.

Parameters:

const TView & viewToScroll -The view being scrolled.
const TGRect & clippedRect -The TScrollingView's clipping rectangle.

Return Value:

Returns the the effect necessary to return the view to the end position.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardScrollCoordinator::GetVerticalUnitScrollIncrement

virtual GCoordinate GetVerticalUnitScrollIncrement ()

Interface Category:

API.

Purpose:

Returns the GCoordinate change caused by a vertical scroll.

Calling Context:

Call this function directly to obtain the GCoordinate change caused by a vertical scroll.

Parameters:

Takes no parameters.

Return Value:

Returns the GCoordinate change caused by a vertical scroll.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardScrollCoordinator::SetVerticalUnitScrollIncrement

virtual void SetVerticalUnitScrollIncrement (GCoordinate amount)

Interface Category:

API.

Purpose:

Sets the GCoordinate change caused by a vertical scroll.

Calling Context:

Call this function directly to set the GCoordinate change caused by a vertical scroll.

Parameters:

GCoordinate amount -The change to be caused by a vertical scroll.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardScrollCoordinator::GetHorizontalUnitScrollIncrement

virtual GCoordinate GetHorizontalUnitScrollIncrement ()

Interface Category:

API.

Purpose:

Returns the GCoordinate change caused by a horizontal scroll.

Calling Context:

Call this function directly to obtain the GCoordinate change caused by a horizontal scroll.

Parameters:

Takes no parameters.

Return Value:

Returns the GCoordinate change caused by a horizontal scroll.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardScrollCoordinator::SetHorizontalUnitScrollIncrement

virtual void SetHorizontalUnitScrollIncrement (GCoordinate amount)

Interface Category:

API.

Purpose:

Sets the GCoordinate change caused by a horizontal scroll.

Calling Context:

Call this function directly to set the GCoordinate change caused by a horizontal scroll.

Parameters:

GCoordinate amount -The change to be caused by a horizontal scroll.

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.