TViewYPosQualifier Class Reference

#include <frmtlay.h>

class TViewYPosQualifier

Detailed 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.

Member Enumeration Documentation

Enum TFullyVisible

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

EnumeratorValueDescription
EFViewForceLineFullyVisibleETrue

Force a partially visible top line to be fully visible.

EFViewDontForceLineFullyVisibleEFalse

Do not force a partially visible top line to be fully visible.

Enum TPartOfLine

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

EnumeratorValueDescription
EFViewTopOfLine1

The top pixel is placed at the specified vertical point.

EFViewBaseLine0

The baseline is placed at the specified vertical point.

EFViewBottomOfLine2

The bottom pixel is placed at the specified vertical point.

Constructor & Destructor Documentation

TViewYPosQualifier ( )

TViewYPosQualifier()[inline]

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.

Member Function Documentation

SetFillScreen ( TBool )

IMPORT_C voidSetFillScreen(TBoolaFillScreen = ETrue)

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
aFillScreenETrue (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.

SetHotSpot ( TPartOfLine )

IMPORT_C voidSetHotSpot(TPartOfLineaHotSpot)

Sets the hotspot.

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

SetMakeLineFullyVisible ( TFullyVisible )

IMPORT_C voidSetMakeLineFullyVisible(TFullyVisibleaMakeLineFullyVisible = EFViewForceLineFullyVisible)

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

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