Symbian^3 Product Developer Library >

TViewYPosQualifier Class Reference

class TViewYPosQualifier

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.

Public Member Functions
TViewYPosQualifier()
IMPORT_C voidSetFillScreen(TBool)
IMPORT_C voidSetHotSpot(TPartOfLine)
IMPORT_C voidSetMakeLineFullyVisible(TFullyVisible)
Public Member Enumerations
enumTFullyVisible { EFViewForceLineFullyVisible = ETrue, EFViewDontForceLineFullyVisible = EFalse }
enumTPartOfLine { EFViewTopOfLine = 1, EFViewBaseLine = 0, EFViewBottomOfLine = 2 }
Private Attributes
TBool iFillScreen
TFullyVisible iFullyVisible
TPartOfLine iHotSpot

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 Functions Documentation

SetFillScreen(TBool)

IMPORT_C voidSetFillScreen(TBoolaFillScreen = ETrue)

Parameters

TBool aFillScreen = ETrue

SetHotSpot(TPartOfLine)

IMPORT_C voidSetHotSpot(TPartOfLineaHotSpot)

Parameters

TPartOfLine aHotSpot

SetMakeLineFullyVisible(TFullyVisible)

IMPORT_C voidSetMakeLineFullyVisible(TFullyVisibleaMakeLineFullyVisible = EFViewForceLineFullyVisible)

Parameters

TFullyVisible aMakeLineFullyVisible = EFViewForceLineFullyVisible

Member Enumerations Documentation

Enum TFullyVisible

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

Enumerators

EFViewForceLineFullyVisible = ETrue

Force a partially visible top line to be fully visible.

EFViewDontForceLineFullyVisible = EFalse

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.

Enumerators

EFViewTopOfLine = 1

The top pixel is placed at the specified vertical point.

EFViewBaseLine = 0

The baseline is placed at the specified vertical point.

EFViewBottomOfLine = 2

The bottom pixel is placed at the specified vertical point.

Member Data Documentation

TBool iFillScreen

TBool iFillScreen[private]

TFullyVisible iFullyVisible

TFullyVisible iFullyVisible[private]

TPartOfLine iHotSpot

TPartOfLine iHotSpot[private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.