TViewYPosQualifier

TViewYPosQualifier

Support

Supported from 5.0

Description

Parameter used to control which part of a line (top, baseline or bottom) should be scrolled to a certain vertical position in a view rectangle. Used as a parameter in functions like CTextView::HandleGlobalChangeL() and CTextLayout::SetViewL(). The selected part of the line is called the hotspot.

Defined in TViewYPosQualifier:
EFViewBaseLine, EFViewBottomOfLine, EFViewDontForceLineFullyVisible, EFViewForceLineFullyVisible, EFViewTopOfLine, SetFillScreen(), SetHotSpot(), SetMakeLineFullyVisible(), TFullyVisible, TPartOfLine, TViewYPosQualifier()

TViewYPosQualifier()

Description

Default C++ constructor.

Constructs a fully initialized TViewYPosQualifier object. The hotspot is initialized to be the baseline of the line, the screen is not filled, and the top line is not forced to be fully visible.

void SetHotSpot(TPartOfLine aHotSpot);

Description

Sets the hotspot.

Parameters

TPartOfLine aHotSpot

Which part of the line (top, baseline or bottom) should appear at a vertical pixel position.

void SetMakeLineFullyVisible(TFullyVisible aMakeLineFullyVisible=EFViewForceLineFullyVisible);

Description

Forces the top line in the view to become fully visible if it is partially above the top of the view rectangle.

Parameters

TFullyVisible aMakeLineFullyVisible

EFViewForceLineFullyVisible (the default) forces the top line to be fully visible EFViewDontForceLineFullyVisible does not.

void SetFillScreen(TBool aFillScreen=ETrue);

Description

Sets whether blank space should be allowed at the bottom of the view. This applies if the document is more than one page long and the last line is visible.

Parameters

TBool aFillScreen

ETrue (the default) tries to fill the screen, by ensuring that there is as little blank space as possible at the bottom of the view. EFalse allows blank space at the bottom.

TPartOfLine

Description

Which part of a line (top, baseline or bottom) should appear at a vertical pixel position.

`EFViewTopOfLine`	The top pixel is placed at the specified vertical point.
`EFViewBaseLine`	The baseline is placed at the specified vertical point.
`EFViewBottomOfLine`	The bottom pixel is placed at the specified vertical point.

TFullyVisible

Description

Whether the top line in the view should be fully visible.

`EFViewForceLineFullyVisible`	Force a partially visible top line to be fully visible.
`EFViewDontForceLineFullyVisible`	Do not force a partially visible top line to be fully visible.

Class `TViewYPosQualifier`

Support

Description

Construction