TCursor Class Reference

#include <frmtview.h>

Link against: form.lib

class TCursor

Detailed Description

Visibility of line and text cursor.

The TVisibility enumeration defined in this class is used in calls to CTextView::SetCursorVisibilityL(). The remainder of this class does not form part of the API.

Member Enumeration Documentation

Enum TCursors

EnumeratorValueDescription
EFNeitherCursor0
EFTextCursor1
EFLineCursor2
EFBothCursorsEFTextCursor | EFLineCursor

Enum TVisibility

Cursor visibility

EnumeratorValueDescription
EFCursorInvisible0

Indicates that the cursor should be invisible.

EFCursorVisible

Indicates that the cursor should be visible.

EFCursorFlashing

Indicates a flashing text cursor. When specified for the line cursor, is equivalent to EFCursorVisible, as the line cursor cannot flash. Note that a non-flashing text cursor should only be used when there is to be no editing, reformatting, scrolling or cursor movement.

Constructor & Destructor Documentation

TCursor ( TCursorPosition &, RScreenDisplay & )

TCursor(TCursorPosition &aCursorPos,
RScreenDisplay &aDisplay
)

Member Function Documentation

Draw ( TUint )

voidDraw(TUintaCursors)

Draws the specified cursors.

LineCursorVisibility ( )

TUint LineCursorVisibility()[inline]

MatchCursorHeightToAdjacentChar ( )

voidMatchCursorHeightToAdjacentChar()

Sets the cursor so that when it is next drawn its metrics will match those of adjacent text: cancels any overriding metrics. Does not redraw.

SetAscentAndDescent ( TInt, TInt )

voidSetAscentAndDescent(TIntaAscent,
TIntaDescent
)

Sets the ascent and descent of the text cursor in pixels and redraw it. To use the ascent or descent of the adjacent character pass a value of -1.

SetExtensions ( TInt, TInt )

voidSetExtensions(TIntaFirstExtension,
TIntaSecondExtension
)

SetFlash ( TBool )

voidSetFlash(TBoolaEnabled)

Sets the flashing state of the cursor and redraws it.

SetLineCursorBitmap ( const CFbsBitmap * )

voidSetLineCursorBitmap(const CFbsBitmap *aLineCursorBitmap)

SetPlacement ( TTmCursorPlacement )

voidSetPlacement(TTmCursorPlacementaPlacement)

SetType ( TTextCursor::EType )

voidSetType(TTextCursor::ETypeaType)

SetVisibility ( TVisibility, TVisibility )

voidSetVisibility(TVisibilityaLineCursor,
TVisibilityaTextCursor
)

SetWeight ( TInt )

voidSetWeight(TIntaWeight)

Changes the cursor weight and redraws it.

SetXorColor ( TRgb )

voidSetXorColor(TRgbaColor)

Sets the XOR colour of the cursor and redraws it.

TextCursorVisibility ( )

TUint TextCursorVisibility()[inline]