#include <frmtlay.h>
| class CTextLayout : public CBase, public CBase |
| Public Member Enumerations | |
|---|---|
| enum | anonymous { EFCharacterInsert, EFParagraphDelimiter, EFLeftDelete, EFRightDelete } |
| enum | anonymous { EFScrollRedrawWholeScreen, EFMaximumLineWidth } |
| enum | anonymous { EFAllParagraphsNotWrapped, EFParagraphsWrappedByDefault } |
| enum | TAllowDisallow { EFAllowScrollingBlankSpace, EFDisallowScrollingBlankSpace } |
| enum | TAmountFormatted { EFFormatAllText, EFFormatBand } |
| enum | TCurrentFormat { EFNoCurrentFormat, EFNotInCurrentFormat } |
| enum | TDiscard { EFViewDiscardAllFormat, EFViewDontDiscardFormat } |
| enum | TPanicNumber { EUnimplemented, ENoMemory, EDrawingBorderError, EFormatDeviceNotSet, ..., EInvalidRedraw } |
| enum | TScrollFlags { EFScrollOnlyToTopsOfLines } |
Text layout.
CTextLayout is the lowest-level text formatting class in the Text Views API. It obtains text and formatting attributes via the MLayDoc interface class and formats the text to a certain width.
It has functions for drawing the text and performing hit-detection that is, converting x-y coordinates to document positions, and vice versa. It defines many public functions that are not generally useful, but are called by the higher-level CTextView class, or exist only for the convenience of closely associated classes like the printing and pagination systems. These are identified in the documentation by the text "not generally useful".
When using the CTextLayout class, you must be aware of what functions have previously been called. For example:
1) Formatting and scrolling functions must not be called if a CTextView object owns the CTextLayout object, because the CTextView object may be reformatting the CTextLayout object asynchronously by means of an active object, or may hold some state information about the CTextLayout object that would be invalidated by reformatting. These functions are identified in the documentation by the text "Do not use if a CTextView object owns this CTextLayout object.".
2) Functions that raise out of memory exceptions can leave the object in an inconsistent state; these functions can be identified as usual by their trailing L. When this occurs, it is necessary to discard the formatting information by calling DiscardFormat().
3) Some functions change formatting parameters like the wrap width or band height, but do not reformat to reflect the change. These functions are identified in the documentation by the text "Reformat needed".
| Enumerator | Value | Description |
|---|---|---|
| EFCharacterInsert |
Insert a character, (not a paragraph delimiter). | |
| EFParagraphDelimiter |
Insert a paragraph delimiter. | |
| EFLeftDelete |
Delete single character to the left. | |
| EFRightDelete |
Delete single character to the right. |
| Enumerator | Value | Description |
|---|---|---|
| EFScrollRedrawWholeScreen | CLayoutData::EFLargeNumber |
A value greater than any possible display height indicates that the entire visible area, at least, was scrolled, and so there is no point in blitting text; a full redraw is needed. |
| EFMaximumLineWidth | CLayoutData::EFBodyWidthForNoWrapping |
The maximum line width when wrapping is unset. |
| Enumerator | Value | Description |
|---|---|---|
| EFAllParagraphsNotWrapped | 1 |
Wrapping off; overrides the paragraph format. |
| EFParagraphsWrappedByDefault | 0 |
Wrapping on, unless CParaFormat::iWrap is false. |
Indicates whether blank space should scroll. Used by several CTextView and CTextLayout scrolling functions.
| Enumerator | Value | Description |
|---|---|---|
| EFAllowScrollingBlankSpace | 1 |
Allow blank space to scroll. |
| EFDisallowScrollingBlankSpace | 0 |
Disallow blank space from scrolling. |
Amount to format. Used by CTextLayout::SetAmountToFormat().
| Enumerator | Value | Description |
|---|---|---|
| EFFormatAllText | 0 |
Format the whole document. |
| EFFormatBand | 1 |
Format the visible band only. |
Formatting information.
| Enumerator | Value | Description |
|---|---|---|
| EFNoCurrentFormat | -1 |
Returned by some CTextLayout enquiry functions to indicate that no formatting has taken place so that the requested value cannot be calculated. |
| EFNotInCurrentFormat | 0 |
Returned by CTextLayout::ParagraphHeight() when the paragraph is not formatted. |
Flags used by CTextLayout::SetViewL(). Whether to reformat and redraw.
| Enumerator | Value | Description |
|---|---|---|
| EFViewDiscardAllFormat | 1 |
Discard all formatting; redraw. |
| EFViewDontDiscardFormat | 0 |
Do not discard all formatting; redraw. |
| Enumerator | Value | Description |
|---|---|---|
| EFScrollOnlyToTopsOfLines | 1 |
| IMPORT_C | ~CTextLayout | ( | ) |
| IMPORT_C void | AdjustVerticalAlignment | ( | CParaFormat::TAlignment | aVerticalAlignment | ) |
Temporarily changes the vertical alignment of the text with respect to the visible height.
Notes:
Not generally useful.
Do not use if a CTextView object owns this CTextLayout object.
| Parameters | |
|---|---|
| aVerticalAlignment | Specifies whether the formatted text should be placed at the top (CParaFormat::ETopAlign), vertical centre (CParaFormat::ECenterAlign or CParaFormat::EJustifiedAlign) or bottom (CParaFormat::EBottomAlign) of the band. CParaFormat::EUnspecifiedAlign or CParaFormat::ECustomAlign may also be specified. These values cause the baseline of the first formatted line to be positioned 82% of the way down the band (provided for the Agenda's application's year view). |
| IMPORT_C TInt | BandHeight | ( | ) | const |
Gets the height of the band in pixels or twips.
| void | BeginRedraw | ( | const TRect & | aRect | ) |
| TBool | BeginRedrawCalled | ( | ) | const |
| IMPORT_C TBool | CalculateHorizontalExtremesL | ( | TInt & | aLeftX, |
| TInt & | aRightX, | |||
| TBool | aOnlyVisibleLines, | |||
| TBool | aIgnoreWrapCharacters = 0 | |||
| ) | const | |||
Returns the left and right extremes, in layout coordinates, of the formatted text.
| Parameters | |
|---|---|
| aLeftX | On return, contains the x coordinate of the leftmost point of the formatted text. |
| aRightX | On return, contains the x coordinate of the rightmost point of the formatted text. |
| aOnlyVisibleLines | If ETrue, only scans partially or fully visible lines. If EFalse, scans all the formatted text. |
| aIgnoreWrapCharacters | If ETrue, does not include wrap characters in the measurement (paragraph delimiters, forced line breaks, etc.). If EFalse, includes them. |
| IMPORT_C TInt | ChangeBandTopL | ( | TInt & | aPixels, |
| TAllowDisallow | aScrollBlankSpace = EFDisallowScrollingBlankSpace | |||
| ) | ||||
Scrolls the text up or down by aPixels pixels, disallowing blank space at the bottom of the visible area if aScrollBlankSpace is CTextLayout::EFDisallowScrollingBlankSpace.
The return value (not aPixels, as you would expect from ScrollParagraphsL() and ScrollLinesL()) contains the number of pixels not successfully scrolled, that is, the original value of aPixels, minus the number of pixels actually scrolled. On return, aPixels is set to the number of pixels actually scrolled.
Do not use if a CTextView object owns this CTextLayout object.
| Parameters | |
|---|---|
| aPixels | The number of pixels to scroll; may be a positive or negative value. On return, contains the number of pixels actually scrolled. |
| aScrollBlankSpace | Only relevant when scrolling downwards. CTextLayout::EFAllowScrollingBlankSpace allows blank space to scroll into the visible area. CTextLayout::EFDisallowScrollingBlankSpace prevents blank space from scrolling into the visible area. |
| IMPORT_C void | ChangeBandTopNoLimitBorderL | ( | TInt | aPixels | ) |
Scrolls the text up or down by aPixels pixels, allowing blank space at top and bottom of the visible area, which means the scrolling can go beyond the top or bottom border.
Do not use if a CTextView object owns this CTextLayout object.
| Parameters | |
|---|---|
| aPixels | The number of pixels to scroll; may be a positive or negative value. The actual scrolled pixel number is always identical to aPixels |
| IMPORT_C const MFormCustomDraw * | CustomDraw | ( | ) | const |
| IMPORT_C const MFormCustomWrap * | CustomWrap | ( | ) | const |
Gets the custom line breaking object, as set using SetCustomWrap().
| IMPORT_C void | DiscardFormat | ( | ) |
Discards all formatting information. This function is used by the CTextView and the printing classes, but should be called by higher-level classes that need to clean up after any CTextLayout function has caused an out-of-memory exception.
Returns the x-y coordinates of the document position aDocPos in aPos. The return value is ETrue if the position is formatted, or EFalse if it is not, in which case aPos is undefined.
Deprecated - use the more powerful FindDocPos() instead
| Parameters | |
|---|---|
| aDocPos | The document position. |
| aPos | On return, contains the x-y coordinates of aDocPos. |
| aFlags | Two possible values: 0 is the default, and performs the task at full accuracy, and CLayoutData::EFWholeLinesOnly, which examines lines only and sets aXyPos.iY only, and cannot leave. |
| IMPORT_C TInt | DocumentLength | ( | ) | const |
Returns the document length in characters, including all the text, not just the formatted portion, but not including the final paragraph delimiter (the "end-of-text character") if any. Thus the length of an empty document is zero.
| void | DrawBackground | ( | CGraphicsContext & | aGc, |
| const TPoint & | aTopLeft, | |||
| const TRect & | aClipRect, | |||
| const TLogicalRgb & | aBackground | |||
| ) | const | |||
| IMPORT_C void | DrawBorders | ( | const MGraphicsDeviceMap * | aGd, |
| CGraphicsContext & | aGc, | |||
| const TRect & | aRect, | |||
| const TParaBorderArray & | aBorder, | |||
| const TRgb * | aBackground = 0, | |||
| TRegion * | aClipRegion = 0, | |||
| const TRect * | aDrawRect = 0 | |||
| ) | [static] | |||
Draws paragraph borders, optionally with a background colour for the border and a clip region. Provided for applications that display a menu of border styles, like a wordprocessor.
| Parameters | |
|---|---|
| aGd | Provides twip-to-pixel conversion. |
| aGc | Graphics context to which to draw the border. Its pen settings are overridden by the values specified by aBorder and its draw mode is set to CGraphicsContext::EDrawModePEN. |
| aRect | The outer bounds of the border. |
| aBorder | Specifies the four sides of the border. |
| aBackground | If not null, the background colour, (used between double border lines, or between dots or dashes). |
| aClipRegion | If non-null, specifies a clip region. |
| aDrawRect | If non-null, and if aClipRegion is non-null, specifies a rectangle to be subtracted from the clip region. |
| IMPORT_C void | DrawL | ( | const TRect & | aDrawRect, |
| const TDrawTextLayoutContext * | aDrawTextLayoutContext, | |||
| const TCursorSelection * | aHighlight = 0 | |||
| ) | ||||
Draws the text. Draws any lines that intersect aDrawRect, which is specified in window coordinates. The drawing parameters, including the graphics context, are given in aDrawTextLayoutContext. If aHighlight is non-null, highlights (by exclusive-ORing) the specified range of text.
| Parameters | |
|---|---|
| aDrawRect | The function draw the lines within the visible area, which intersect this rectangle (which is specified in window coordinates). |
| aDrawTextLayoutContext | Provides a graphics context and other parameters for the function. |
| aHighlight | If not NULL, this range of text is drawn highlighted. |
| void | EndRedraw | ( | ) |
| IMPORT_C TBool | ExcludingPartialLines | ( | ) | const |
Tests whether partial lines at the top and bottom of the view are currently excluded.
Deprecated7.0
| IMPORT_C void | ExtendFormattingToCoverPosL | ( | TInt | aDocPos | ) |
| Parameters | |
|---|---|
| aDocPos | Position in the text you wish to extend the formatting to. e.g. passing in 0 will increase the formatting range to the very first character entered in the document. |
| IMPORT_C void | ExtendFormattingToCoverYL | ( | TInt | aYPos | ) |
Makes sure the line that aYPos is in (if it exists) is covered by the formatting.
| Parameters | |
|---|---|
| aYPos | Y pixel position in window-relative co-ordinates. |
| IMPORT_C TBool | FindDocPos | ( | const TTmDocPosSpec & | aDocPos, |
| TTmPosInfo2 & | aPosInfo, | |||
| TTmLineInfo * | aLineInfo = 0 | |||
| ) | const | |||
Finds the x-y position of the document position aDocPos.
If ETrue is returned, places information about the document position in aPosInfo and information about the line containing the document position in aLineInfo if it is non-NULL.
| Parameters | |
|---|---|
| aDocPos | Contains the document position to check. |
| aPosInfo | On return, stores information about the document position if the position is formatted. |
| aLineInfo | Buffer to store the line information if the document position is formatted. |
| IMPORT_C TBool | FindXyPos | ( | const TPoint & | aXyPos, |
| TTmPosInfo2 & | aPosInfo, | |||
| TTmLineInfo * | aLineInfo = 0 | |||
| ) | const | |||
Finds the document position nearest to aXyPos. If aXyPos is in the formatted text returns ETrue, otherwise returns EFalse. If ETrue is returned, places information about the document position in aPosInfo and information about the line containing the document position in aLineInfo if it is non-NULL.
| Parameters | |
|---|---|
| aXyPos | Contains coordinates to convert to a document position. |
| aPosInfo | Buffer to store information about the document position if the specified coordinates are located in the formatted text. |
| aLineInfo | Buffer to store information about the line if the specified coordinates are located in the formatted text. |
Gets the document position of the first character in the specified line, counting the first line as line one (not zero) in the band. If the line is after the band, returns the last character position of the band. If there is no formatted text, returns CTextLayout::EFNoCurrentFormat.
| Parameters | |
|---|---|
| aLineNo | Line number in formatted text, counting the first line as line one. |
| IMPORT_C TInt | FirstDocPosFullyInBand | ( | ) | const |
Gets the first document position in a line that starts at or below the top of the visible area. If there is no such line, returns the position after the last formatted character.
| IMPORT_C TInt | FirstFormattedPos | ( | ) | const |
Returns the document position of the first formatted character.
| IMPORT_C TInt | FirstLineInBand | ( | ) | const |
Returns the line number, counting from 0, of the first fully visible line.
| IMPORT_C TInt | FontHeightIncreaseFactor | ( | ) | const |
Returns the font height increase factor as a percentage (i.e. a return value of 7 means that font heights are increased by 7% to provide automatic extra spacing between lines).
| IMPORT_C void | ForceNoWrapping | ( | TBool | aNoWrapping = EFAllParagraphsNotWrapped | ) |
Turns wrapping on (if aNoWrapping is EFParagraphsWrappedByDefault) or off (if aNoWrapping is EFAllParagraphsNotWrapped). Overrides the paragraph format when wrapping is turned off -paragraphs are not broken into lines even if the iWrap member of CParaFormat is ETrue. If wrapping is turned on, CParaFormat::iWrap is honoured.
The text needs to be reformatted after a call to this function.
| Parameters | |
|---|---|
| aNoWrapping | EFAllParagraphsNotWrapped (the default) to turn wrapping off, EFParagraphsWrappedByDefault to turn wrapping on. |
| IMPORT_C void | FormatBandL | ( | ) |
Formats enough text to fill the visible band.
Note: Do not use if a CTextView object owns this CTextLayout object.
Sets the formatted text to begin at the start of the paragraph including aStartPos and end at aEndPos. Moves the line containing aStartDocPos to the top of the visible area.
Notes:
This function is not generally useful; it exists for the convenience of the printing system.
Do not use if a CTextView object owns this CTextLayout object.
| Parameters | |
|---|---|
| aStartDocPos | A document position within the paragraph from which to begin formatting. |
| aEndDocPos | Document position at which to end formatting. |
| IMPORT_C TBool | FormatLineL | ( | CParaFormat * | aParaFormat, |
| TInt & | aDocPos, | |||
| TInt & | aHeight, | |||
| TBool & | aPageBreak | |||
| ) | ||||
Controls the height of a single line, for use by the pagination system only. Using the format supplied in aParaFormat, determines the height of the line containing aDocPos and returns it in aHeight. Changes aDocPos to the end of the line and returns ETrue if that position is not the end of the paragraph.
Notes:
Not generally useful; it exists for use by the pagination system only.
Do not use if a CTextView object owns this CTextLayout object.
| Parameters | |
|---|---|
| aParaFormat | Contains paragraph formatting. |
| aDocPos | A document position. On return, contains the document position of the end of the line. |
| aHeight | On return, contains the height of the formatted line containing aDocPos. |
| aPageBreak | On return, ETrue if the last character on the line is a page break. EFalse if not. |
A special function to support background formatting by the higher level CTextView class. It formats the next pending line. The return value is ETrue if there is more formatting to do. On entry, aBotPixel contains the y coordinate of the bottom of the formatted text; this is updated by the function.
Notes:
Not generally useful.
Do not use if a CTextView object owns this CTextLayout object.
| Parameters | |
|---|---|
| aBotPixel | On entry, contains the y coordinate of the bottom of the formatted text; this is updated by the function. |
| IMPORT_C TInt | FormattedHeightInPixels | ( | ) | const |
Returns the height in pixels of the formatted text.
| IMPORT_C TInt | FormattedLength | ( | ) | const |
Returns the number of formatted characters. This will be one more than expected if the formatted text runs to the end of the document, because it will include the end-of-text character.
Gets the height (ascent + descent) and ascent of the font of the character at aDocPos, as created using the graphics device map used for drawing (the "image device") and returns them in aHeight and aAscent, after increasing aHeight by the font height increase factor (see SetFontHeightIncreaseFactor()).
| Parameters | |
|---|---|
| aDocPos | A document position. |
| aHeight | On return contains the height in pixels of the character at aDocPos. |
| aAscent | On return, contains the ascent in pixels of the character at aDocPos. |
| TBool | GetCursor | ( | const TTmDocPos & | aDocPos, |
| TTmCursorPlacement | aPlacement, | |||
| TRect & | aLineRect, | |||
| TPoint & | aOrigin, | |||
| TInt & | aWidth, | |||
| TInt & | aAscent, | |||
| TInt & | aDescent | |||
| ) | const | |||
| IMPORT_C MFormCustomInvisibleCharacterRemapper * | GetCustomInvisibleCharacterRemapper | ( | ) |
Allows Form clients to see which character remapper object is currently registered.
| IMPORT_C void | GetFontHeightAndAscentL | ( | const TFontSpec & | aFontSpec, |
| TInt & | aHeight, | |||
| TInt & | aAscent | |||
| ) | const | |||
Gets the height (ascent + descent) and ascent of the font specified by aFontSpec, as created using the graphics device map used for drawing (the "image device") and puts them into aHeight and aAscent, after increasing aHeight by the font height increase factor (see SetFontHeightIncreaseFactor()).
| Parameters | |
|---|---|
| aFontSpec | Font specification. |
| aHeight | On return, contains the height in pixels of the font. |
| aAscent | On return, contains the ascent in pixels of the font. |
| void | GetHighlightRemnants | ( | const TRect & | aRect, |
| const TDrawTextLayoutContext & | aDrawTextLayoutContext, | |||
| TRect * | aRemainderRects | |||
| ) | const | |||
For any rectangle, aRect, which may be extended, calculate the "remainder" rectanges when the view rectangle is intersected with the extended rect and then subtracted. The remainder rectangles are returned via aRemainderRects, which is required to be a pointer to an array of 4 TRect's. aRemainderRects[0] is top remainder, ...[1] is bottom, ...[2] is left, ...[3] is right
Gets the rectangle enclosing the formatted line that contains or is closest to y coordinate aYPos. If aYPos is above the first formatted line, the rectangle returned is that of the first formatted line. If aYPos is below the last formatted line the rectangle returned is that of the last formatted line. If there is no formatted text, returns CTextLayout::EFNoCurrentFormat.
| Parameters | |
|---|---|
| aYPos | The y coordinate of the line of interest. |
| aLine | On return, contains the rectangle which encloses the line at aYPos. |
Gets a rectangle enclosing two formatted document positions on the same line. If the second position is less than the first, or on a different line, it is taken to indicate the end of the line. This function panics if either position is unformatted.
Note:
CTextLayout must have been set with a valid wrap width and band height before calling this function, otherwise no formatting will take place and the function will panic. Wrap width and band height values must be > 0 to be valid.
See also: SetBandHeight SetWrapWidth
| Parameters | |
|---|---|
| aDocPos1 | The first document position on the line. |
| aDocPos2 | The second document position on the line. |
Gets the width and height of the bounding box of the text, including indents and margins, when formatted to the specified wrap width.
| Parameters | |
|---|---|
| aWrapWidth | The wrap width for the bounding box. |
| aSize | On return, contains the width and height of the bounding box. |
Gets the width and height of the bounding box of the text, including indents and margins, when formatted to the specified wrap width.
| Parameters | |
|---|---|
| aWrapWidth | The wrap width for the bounding box. |
| aAllowLegalLineBreaksOnly | ETrue to only allow legal line breaks, or EFalse to also allow illegal line breaks. |
| aSize | On return, contains the width and height of the bounding box. |
| IMPORT_C TBool | GetNextVisualCursorPos | ( | const TTmDocPosSpec & | aDocPos, |
| TTmPosInfo2 & | aPosInfo, | |||
| TBool | aToLeft | |||
| ) | const | |||
Finds the next cursor position to aDocPos in the visually ordered line.
| Parameters | |
|---|---|
| aDocPos | Contains the document position to check. |
| aPosInfo | On return, stores information about the document position of the next cursor position, if ETrue is returned. |
| aToLeft | ETrue if the position to the left is to be found, or EFalse if the position to the right is to be found. |
| void | GetOrigin | ( | TPoint & | aPoint | ) | const [inline] |
Reformats to reflect the addition of one or more complete paragraphs at the end of the text.
Do not use if a CTextView object owns this CTextLayout object.
| Parameters | |
|---|---|
| aFirstPixel | On return, the top y coordinate of the added material. |
| aLastPixel | On return, the bottom y coordinate of the added material. |
| IMPORT_C void | HandleBlockChangeL | ( | TCursorSelection | aSelection, |
| TInt | aOldCharsChanged, | |||
| TViewRectChanges & | aViewChanges, | |||
| TBool | aFormatChanged | |||
| ) | ||||
Reformats to reflect changes to a block of text.
Do not use if a CTextView object owns this CTextLayout object.
| Parameters | |
|---|---|
| aSelection | The start and new length of the changed block. When inserting, specify the insertion position. When deleting, specify the position of the start of the deletion. When reformatting, specify the start and length of the reformatted block. |
| aOldCharsChanged | The old length of the changed block. When inserting, specify zero. When deleting, specify the number of deleted characters. When reformatting, specify the number of reformatted characters. |
| aViewChanges | On return, contains the top of the reformatted text (iFormattedFrom), the bottom of the reformatted text (iFormattedTo), the amount by which the text above the reformatted text has scrolled (iScrollAtTop) and the amount by which the text below the reformatted text has scrolled (iScrollAtBottom) (positive values mean the text moves down). |
| aFormatChanged | Indicates whether the paragraph format for the first or last affected paragraph has changed, meaning that the text to be reformatted must extend out to paragraph boundaries and cannot be restricted to only some lines. |
| IMPORT_C TBool | HandleCharEditL | ( | TUint | aType, |
| TInt & | aCursorPos, | |||
| TInt & | aGood, | |||
| TInt & | aFormattedUpTo, | |||
| TInt & | aFormattedFrom, | |||
| TInt & | aScroll, | |||
| TBool | aFormatChanged | |||
| ) | ||||
Reformats to reflect a single character edit.
Do not use if a CTextView object owns this CTextLayout object.
| Parameters | |
|---|---|
| aType | Indicates the type of edit which has taken place. CTextLayout::EFCharacterInsert (the default) for a character insertion, CTextLayout::EFParagraphDelimiter for a paragraph delimiter insertion, CTextLayout::EFLeftDelete or CTextLayout::EFRightDelete for a character or paragraph delimiter deletion to the left or right of the document position. |
| aCursorPos | The document position at which the edit took place, before the edit. If this position is not formatted, a panic occurs; it is modified in accordance with the edit. |
| aGood | On return, the y coordinate of the top of the paragraph following the paragraph which has been edited, before the edit. |
| aFormattedUpTo | On return, the y coordinate of the bottom of the reformatted line or lines, after the edit. |
| aFormattedFrom | On return, the vertical layout coordinate of the top of the reformatted line or lines, after the edit. |
| aScroll | The number of pixels by which the text had to be scrolled (positive means text moved down). |
| aFormatChanged | ETrue if text is to be reformatted from the start of the paragraph the cursor was on before the edit, EFalse if from the start of the line the cursor was on before the edit. |
| IMPORT_C void | Highlight | ( | const TRangeChange & | aHighlight, |
| const TRect & | aDrawRect, | |||
| const TDrawTextLayoutContext * | aDrawTextLayoutContext | |||
| ) | ||||
Sets or clears a highlight.
If the range of characters to highlight is of zero length, the function has no effect.
The function affects only those lines that intersect aDrawRect, which is specified in window coordinates. The drawing parameters, including the graphics context, are given in aDrawTextLayoutContext.
From v7.0, this function replaces InvertRangeL().
This function is not intended to be used to set any part of a highlight already set, nor to clear any piece of text not highlighted. It is intended to do either or both of: clear an existing selection, set a new selection. See the class description for TRangeChange for a code fragment showing how this function should be used.
| Parameters | |
|---|---|
| aHighlight | Specifies the range of characters to highlight or from which to remove the highlight. |
| aDrawRect | Only lines which intersect this rectangle are affected (specified in window coordinates). |
| aDrawTextLayoutContext | Provides a graphics context and other drawing parameters, e.g. the text and background colours for the highlighted region. |
| const TTmHighlightExtensions & | HighlightExtensions | ( | ) | const [inline] |
| void | HighlightUsingExtensions | ( | const CTextLayout::TRangeChange & | aChangeHighlight, |
| const TRangeChange & | aFullHighlight, | |||
| const TRect & | aDrawRect, | |||
| const TDrawTextLayoutContext * | aDrawTextLayoutContext | |||
| ) | ||||
| IMPORT_C void | InvertRangeL | ( | const TCursorSelection & | aHighlight, |
| const TRect & | aDrawRect, | |||
| const TDrawTextLayoutContext * | aDrawTextLayoutContext | |||
| ) | ||||
Toggles the selection highlight for the range of text in aHighlight.
Highlights only those lines that intersect aDrawRect, which is specified in window coordinates. The drawing parameters, including the graphics context, are given in aDrawTextLayoutContext.
In v7.0 and onwards, this function is deprecated -Highlight() should be used instead. Deprecated
| Parameters | |
|---|---|
| aHighlight | The range of characters for which to invert the highlighting. |
| aDrawRect | Only lines which intersect this rectangle are affected; specified in window coordinates. |
| aDrawTextLayoutContext | Provides a graphics context and other drawing parameters. |
| IMPORT_C TBool | IsBackgroundFormatting | ( | ) | const |
Tests whether background formatting is currently taking place. Background formatting is managed by CTextView, using an active object, when the CTextLayout object is owned by a CTextView object.
Not generally useful.
| IMPORT_C TBool | IsFormattingBand | ( | ) | const |
Tests whether band formatting is on, as set by CTextLayout::SetAmountToFormat().
| IMPORT_C TBool | IsWrapping | ( | ) | const |
Tests whether wrapping is on or off.
| IMPORT_C TInt | MajorVersion | ( | ) | const |
Return the FORM major version number. This function is not generally useful. It is used in test code and was used while making a transition between this and the former version of FORM. The return value is always 2.
| IMPORT_C void | MakeVisible | ( | TBool | aVisible | ) |
Stops or allows text to be drawn. Included to allow users to control visibility if text is part of an invisible control.
See also: CCoeControl::MakeVisible()
| Parameters | |
|---|---|
| aVisible | ETrue to make the text visible, EFalse to make it invisible. |
| IMPORT_C TInt | MinimumLineDescent | ( | ) | const |
Returns the minimum line descent in pixels.
| IMPORT_C CTextLayout * | NewL | ( | MLayDoc * | aDoc, |
| TInt | aWrapWidth | |||
| ) | [static] | |||
Allocates and constructs a CTextLayout object. By default, the formatting is set to the entire document (EFFormatAllText).
The text needs to be reformatted after a call to this function.
| Parameters | |
|---|---|
| aDoc | Pointer to the MLayDoc implementation that is the source of the text and formatting information. Must not be NULL or a panic occurs. |
| aWrapWidth | The wrapping width in pixels. |
| IMPORT_C TNonPrintingCharVisibility | NonPrintingCharsVisibility | ( | ) | const |
Returns which non-printing characters are drawn using symbols.
| IMPORT_C void | NotifyTerminateBackgroundFormatting | ( | ) |
CTextView calls this function when background formatting has ended. It allows the CTextLayout object to discard information used only during background formatting.
Not generally useful.
| IMPORT_C TInt | NumFormattedLines | ( | ) | const |
Gets the number of formatted lines.
Scrolls down by a page (that is the band height as set by SetBandHeight(), or half that amount if scrolling over lines taller than this), moving the text upwards. The current desired vertical cursor position is passed in aYCursorPos and updated to a new suggested position as near as possible to it, but within the visible text and on a baseline.
Do not use if a CTextView object owns this CTextLayout object.
| Parameters | |
|---|---|
| aYCursorPos | The current desired vertical cursor position. On return, updated to a new suggested position as near as possible to it. |
| aPixelsScrolled | On return, contains the number of pixels scrolled - a negative value. |
Scrolls up by a page (that is the band height as set by SetBandHeight(), or half that amount if scrolling over lines taller than this), moving the text downwards. The current desired vertical cursor position is passed in aYCursorPos and updated to a new suggested position as near as possible to it, but within the visible text and on a baseline.
Do not use if a CTextView object owns this CTextLayout object.
| Parameters | |
|---|---|
| aYCursorPos | The current desired vertical cursor position. On return, updated to a new suggested position as near as possible to it. |
| aPixelsScrolled | On return, contains the number of pixels scrolled. |
| void | Panic | ( | TPanicNumber | aNumber | ) | [static] |
Returns the height of the paragraph containing aDocPos. If the paragraph is not formatted, returns zero. If the paragraph is partially formatted, returns the height of the formatted part.
| Parameters | |
|---|---|
| aDocPos | A document position within the paragraph of interest. |
Returns the rectangle enclosing the paragraph containing aDocPos. If the paragraph is not formatted, returns an empty rectangle. If the paragraph is partially formatted, returns the rectangle enclosing the formatted part.
| Parameters | |
|---|---|
| aDocPos | A document position within the paragraph. |
| TInt | PictureRectangleAndPosL | ( | const TPoint & | aXyPos, |
| TRect & | aPictureRect, | |||
| TBool * | aCanScaleOrCrop = 0 | |||
| ) | const | |||
Finds if there is a picture at the position under the point aXyPos. If there is, returns the document position of it, sets the rectangle occupied in aPictureRect, and whether the picture allows scaling in aCanScaleOrCrop, if non-null. Note that aXyPos may be outside the picture found.
Gets the bounding rectangle of the picture, if any, located at the document position or coordinates specified, and returns it in aPictureRect.
If aCanScaleOrCrop is non-null, sets aCanScaleOrCrop to indicate whether the picture can be scaled or cropped. Returns ETrue if the operation was successful. Returns EFalse otherwise; that is, if there is no picture at the position, or if the position is unformatted.
| Parameters | |
|---|---|
| aDocPos | The document position of interest. |
| aPictureRect | On return, contains the rectangle which encloses the picture located at the position specified. |
| aCanScaleOrCrop | If non-NULL and the function returns ETrue, on return, indicates whether the picture can be scaled or cropped. By default, NULL. |
| IMPORT_C TBool | PictureRectangleL | ( | const TPoint & | aXyPos, |
| TRect & | aPictureRect, | |||
| TBool * | aCanScaleOrCrop = 0 | |||
| ) | const | |||
Gets the bounding rectangle of the picture (if any) at aXyPos and puts it in aPictureRect. If aCanScaleOrCrop is non-null sets *aCanScaleOrCrop to indicate whether the picture can be scaled or cropped. Note that aXyPos may be outside aPictureRect on a successful return, if the picture does not occupy the whole of the section of the line it is in.
| IMPORT_C TInt | PixelsAboveBand | ( | ) | const |
Returns the height in pixels of any formatted text above the visible region.
| IMPORT_C TBool | PosInBand | ( | const TTmDocPos & | aDocPos, |
| TTmLineInfo * | aLineInfo = 0 | |||
| ) | const | |||
Tests whether the document position aDocPos is fully or partially visible. If it is, puts the baseline of the line containing aDocPos into aLineInfo.
| Parameters | |
|---|---|
| aDocPos | The document position of interest. |
| aLineInfo | On return, contains the baseline of the line containing aDocPos. |
Tests whether the document position aDocPos is fully or partially visible. If it is, puts the y coordinate of the left-hand end of the baseline of the line containing aDocPos into aXyPos.
| Parameters | |
|---|---|
| aDocPos | The document position of interest. |
| aXyPos | On return, contains the y coordinate of the left-hand end of the baseline of the line containing aDocPos. |
Tests whether the document position aDocPos is fully or partially visible. If it is, puts the y coordinate of the left-hand end of the baseline of the line containing aDocPos into aXyPos.
| Parameters | |
|---|---|
| aDocPos | The document position of interest. |
| aXyPos | On return, contains the y coordinate of the left-hand end of the baseline of the line containing aDocPos. |
Tests whether the character aDocPos is formatted.
Note:
If a section of text contains characters p to q, it contains document positions p to q + 1; but this function returns ETrue for positions p to q only, so it refers to characters, not positions. However, it will return ETrue for q if q is the end of the document.
| Parameters | |
|---|---|
| aDocPos | The document position of interest. |
Returns the number of fully or partially visible characters in the visible band.
| Parameters | |
|---|---|
| aDocPos | On return, contains the document position of the first fully or partially visible character in the band. |
| IMPORT_C void | ReformatVerticalSpaceL | ( | ) |
Reformats to reflect changes to the space above and below paragraphs (CParaFormat::iSpaceBeforeInTwips and iSpaceAfterInTwips).
Do not use if a Deprecated6.1 Use CTextView object owns this CTextLayout object. FormatBandL()
| void | ResetExternalDraw | ( | ) |
| void | RestrictScrollToTopsOfLines | ( | TBool | aRestrict | ) | [inline] |
Dangerous function. Makes scroll operations set the top of the screen flush to the top of a line. In general this might scroll the cursor off the screen.
| IMPORT_C TInt | ScrollLinesL | ( | TInt & | aNumLines, |
| TAllowDisallow | aScrollBlankSpace = EFDisallowScrollingBlankSpace | |||
| ) | ||||
Scrolls the text up or down by aNumLines lines, disallowing blank space at the bottom of the visible area if aScrollBlankSpace is CTextLayout::EFDisallowScrollingBlankSpace.
Do not use if a CTextView object owns this CTextLayout object.
| Parameters | |
|---|---|
| aNumLines | The number of lines to scroll; may be a positive or negative value. On return, contains the number of lines not scrolled; that is, the requested number, minus the number actually scrolled. |
| aScrollBlankSpace | Only relevant when scrolling downwards. CTextLayout::EFAllowScrollingBlankSpace allows blank space to scroll into the visible area. CTextLayout::EFDisallowScrollingBlankSpace prevents blank space from scrolling into the visible area. |
| IMPORT_C TInt | ScrollParagraphsL | ( | TInt & | aNumParas, |
| TAllowDisallow | aScrollBlankSpace | |||
| ) | ||||
Scrolls the text up or down by aNumParas paragraphs, disallowing blank space at the bottom of the visible area if aScrollBlankSpace is CTextLayout::EFDisallowScrollingBlankSpace.
Do not use if a CTextView object owns this CTextLayout object.
| Parameters | |
|---|---|
| aNumParas | The number of paragraphs to scroll; may be a positive or negative value. On return, contains the number of paragraphs not scrolled; that is the difference between the requested number and the number of paragraphs actually scrolled. |
| aScrollBlankSpace | Only relevant when scrolling downwards. CTextLayout::EFAllowScrollingBlankSpace allows blank space to scroll into the visible area. CTextLayout::EFDisallowScrollingBlankSpace prevents blank space from scrolling into the visible area. |
| IMPORT_C void | SetAmountToFormat | ( | TAmountFormatted | aAmountOfFormat = EFFormatBand | ) |
Sets whether to format all the text (if aAmountOfFormat is EFFormatAllText), or just the visible band (if aAmountOfFormat is EFFormatBand). If band formatting is selected, enough text is formatted to fill the visible height.
The text needs to be reformatted after a call to this function.
| Parameters | |
|---|---|
| aAmountOfFormat | CTextLayout::EFFormatBand (the default) to format the visible text only. CTextLayout::EFFormatAllText to format all the text in the document. |
| IMPORT_C void | SetBandHeight | ( | TInt | aHeight | ) |
Sets the height of the band in pixels or twips. This is the height of the visible text, or the view window, and it is also the page height for the purposes of scrolling up and down by page. If the current mode is screen mode (CLayoutData::EFScreenMode) or what-you-see-is-what-you-get mode (CLayoutData::EFWysiwygMode), aHeight is in pixels, otherwise it is in twips.
The text needs to be reformatted after a call to this function.
Note:
A valid band height (>0) must be supplied or the expected amount of formatting will not take place. This could lead to panics when trying to retrieve formatting information that does not exist.
| Parameters | |
|---|---|
| aHeight | The band height in pixels or twips. |
| IMPORT_C void | SetCustomDraw | ( | const MFormCustomDraw * | aCustomDraw | ) |
| Parameters | |
|---|---|
| aCustomDraw | Pointer to a custom drawing object. |
| IMPORT_C void | SetCustomInvisibleCharacterRemapper | ( | MFormCustomInvisibleCharacterRemapper * | aInvisibleCharacterRemapper | ) |
Allows Form clients to register an invisible character remapper object to customize the visible display of invisible characters such as paragraph marks.
| Parameters | |
|---|---|
| aInvisibleCharacterRemapper | Pointer to custom invisible character remapper to use |
| IMPORT_C void | SetCustomWrap | ( | const MFormCustomWrap * | aCustomWrap | ) |
Sets custom line breaking.
If this function is not called, default line breaking behaviour is used.
Ownership of the custom line breaking object is not transferred to this object.
| Parameters | |
|---|---|
| aCustomWrap | A pointer to an object that implements the custom line breaking interface. Specify NULL to disable custom line breaking. |
| void | SetExcessHeightRequired | ( | TInt | aExcessHeightRequired | ) |
Set the delta required to position the baseline so there is enough space for the highset glyph in pixels. This is the height of the highest glyph - CFont::AscentInPixels(). Only used when using TLineSpacingControl::EAttLineSpacingControl. By default zero.
| Parameters | |
|---|---|
| aExcessHeightRequired | Extra height above CFont::AscentInPixels() required for the highest glyph in pixels. |
| IMPORT_C void | SetExcludePartialLines | ( | TBool | aExcludePartialLines = 1 | ) |
Specifies whether partially displayed lines (at the top and bottom of the view) are to be prevented from being drawn, and whether the top of the display is to be aligned to the nearest line.
This function takes effect only when the text is next formatted or scrolled.Note:This function was designed for non-editable text in the Agenda application, and there is an important restriction: CTextView functions that reformat the text after editing must not be used while partial lines are excluded; these functions are CTextView::HandleCharEditL(), CTextView::HandleInsertDeleteL() and CTextView::HandleRangeFormatChangeL().
Deprecated7.0
| Parameters | |
|---|---|
| aExcludePartialLines | ETrue (the default) to exclude partially displayed lines from the view. EFalse to include them. |
| void | SetExternalDraw | ( | const TRect & | aRect | ) |
| IMPORT_C void | SetFontHeightIncreaseFactor | ( | TInt | aPercentage | ) |
Sets the percentage by which font heights are increased in order to provide automatic extra spacing (leading) between lines. This amount is set to CLayoutData::EFFontHeightIncreaseFactor, which is 7, when a CTextLayout object is created.
The text needs to be reformatted after a call to this function.
| Parameters | |
|---|---|
| aPercentage | Factor by which to increase font heights. |
| IMPORT_C void | SetFormatMode | ( | CLayoutData::TFormatMode | aFormatMode, |
| TInt | aWrapWidth, | |||
| MGraphicsDeviceMap * | aFormatDevice | |||
| ) | ||||
Sets the format mode and wrap width and (for certain format modes only) sets the formatting device.
The text needs to be reformatted after a call to this function.
Notes:
If aFormatMode is CLayoutData::EFWysiwygMode or CLayoutData::EFPrintPreviewMode, the format device is set to aFormatDevice, which must not be NULL.
If aFormatMode is CLayoutData::EFScreenMode or CLayoutData::EFPrintMode, aFormatDevice is ignored and should be NULL; the format device is set to the image device.
The wrap width is set in either twips or pixels using the same rule as for SetWrapWidth().
| Parameters | |
|---|---|
| aFormatMode | The format mode. |
| aWrapWidth | The wrap width in pixels or twips. |
| aFormatDevice | The formatting device or NULL, depending on the format mode. |
| IMPORT_C void | SetHighlightExtensions | ( | TInt | aLeftExtension, |
| TInt | aRightExtension, | |||
| TInt | aTopExtension, | |||
| TInt | aBottomExtension | |||
| ) | ||||
Sets offsets for the edges of the selection highlight.
| Parameters | |
|---|---|
| aLeftExtension | Number of pixels to move the left edge of the highlight to the left. |
| aRightExtension | Number of pixels to move the right edge of the highlight to the right. |
| aTopExtension | Number of pixels to move the top edge of the highlight to up. |
| aBottomExtension | Number of pixels to move the bottom edge of the highlight down. |
| IMPORT_C void | SetImageDeviceMap | ( | MGraphicsDeviceMap * | aGd | ) |
Sets the device map used for drawing and formatting. This device map is also used for formatting and drawing paragraph labels unless a separate label device map has been set (see SetLabelsDeviceMap()).
The text needs to be reformatted after a call to this function.
Note:
Although the name of the function suggests that only the image device is set, the formatting device is also set.
| Parameters | |
|---|---|
| aGd | The device map used for drawing and formatting. |
| IMPORT_C void | SetInterfaceProvider | ( | MFormCustomInterfaceProvider * | aProvider | ) |
This method allows Form clients to register an object able to create or return references to customisation objects used within Form for various tasks e.g. inline text.
| Parameters | |
|---|---|
| aProvider | Reference to interface provider object to register with Formm. |
| IMPORT_C void | SetLabelsDeviceMap | ( | MGraphicsDeviceMap * | aDeviceMap | ) |
Sets the device map used for formatting and drawing paragraph labels. If not set, the device map used for labels will be the same as that used for the text.
The text needs to be reformatted after a call to this function.
| Parameters | |
|---|---|
| aDeviceMap | The device map used for formatting and drawing paragraph labels. |
| IMPORT_C void | SetLabelsMarginWidth | ( | TInt | aWidth | ) |
Sets the width in pixels of the margin in which labels are drawn.
The text needs to be reformatted after a call to this function.
| Parameters | |
|---|---|
| aWidth | The width in pixels of the labels margin. |
| IMPORT_C void | SetLayDoc | ( | MLayDoc * | aDoc | ) |
Sets the layout object's source text to aDoc.
The text needs to be reformatted after a call to this function.
| Parameters | |
|---|---|
| aDoc | Pointer to the MLayDoc implementation that is the source of the text and formatting information. Must not be NULL or a panic occurs. |
| IMPORT_C void | SetMinimumLineDescent | ( | TInt | aPixels | ) |
Sets the minimum line descent in pixels. This amount is set to CLayoutData::EFMinimumLineDescent, which is 3, when a CTextLayout object is created.
The text needs to be reformatted after a call to this function.
| Parameters | |
|---|---|
| aPixels | The minimum line descent in pixels. |
| IMPORT_C void | SetNonPrintingCharsVisibility | ( | TNonPrintingCharVisibility | aVisibility | ) |
Specifies which non-printing characters (e.g. space, paragraph break, etc.) are to be drawn using symbols.
The text needs to be reformatted after a call to this function.(because non-printing characters may differ in width from their visible representations).
| Parameters | |
|---|---|
| aVisibility | Indicates which non-printing characters are drawn using symbols. |
| void | SetOpaqueLC | ( | ) |
Sets opaque drawing flag for CTextLayout object. It will used later when the content/background has to be drawn. Until the flag is not reseted, the opaque drawing will be used for all the content except the background - the flag has an useful meaning only for transparent editors. A TCleanupItem object will be pushed into the Cleanup Stack, which will reset the opaque flag durring its destruction.
| void | SetReadyToRedraw | ( | ) |
| void | SetTextViewCursorPos | ( | TCursorPosition * | aPos | ) |
INC092568: CTextView::SetPendingSelection is not honoured Sets the cursor position member added for this fix that allows the text layout object to access any pending selection made by the owning text view object
| IMPORT_C void | SetTruncating | ( | TBool | aOn | ) |
Sets the truncation mode. If truncation is on, lines that exceed the wrap width, either because they have no legal line break, or because wrapping is off, are truncated, and an ellipsis is inserted.
| Parameters | |
|---|---|
| aOn | If ETrue, lines which extend beyond the wrap width are truncated with an ellipsis character. If EFalse, no ellipsis is used. |
| IMPORT_C void | SetTruncatingEllipsis | ( | TChar | aEllipsis | ) |
Sets the ellipsis character to be used if truncation is on. Specify the value 0xFFFF (the illegal Unicode character) if no ellipsis character should be used. By default, the ellipsis character is 0x2026, the ordinary horizontal ellipsis.
| Parameters | |
|---|---|
| aEllipsis | The Unicode value of the truncating ellipsis character. |
| IMPORT_C TInt | SetViewL | ( | const TTmDocPos & | aDocPos, |
| TInt & | aYPos, | |||
| TViewYPosQualifier | aYPosQualifier, | |||
| TDiscard | aDiscardFormat = EFViewDontDiscardFormat | |||
| ) | ||||
Changes the top of the visible area so that the line containing aDocPos is vertically positioned at aYPos. Which part of the line is set to appear at aYPos (top, baseline, or bottom) is controlled by the TViewYPosQualifier argument, which also specifies whether the visible area is to be filled and whether the line should be made fully visible if possible.
Do not use if a CTextView object owns this CTextLayout object.
| Parameters | |
|---|---|
| aDocPos | A valid document position. |
| aYPos | The y coordinate at which to display the character at aDocPos. On return, contains the actual vertical position of the specified part of the line. |
| aYPosQualifier | Controls which part of the line is set to appear at aYPos. |
| aDiscardFormat | If ETrue (EFViewDiscardAllFormat), the text is reformatted to include aDocPos, otherwise text is formatted only as necessary when bringing new lines into the visible area. |
| IMPORT_C TInt | SetViewL | ( | TInt | aDocPos, |
| TInt & | aYPos, | |||
| TViewYPosQualifier | aYPosQualifier, | |||
| TDiscard | aDiscardFormat = EFViewDontDiscardFormat | |||
| ) | ||||
This interface is deprecated, and is made available in version 7.0s solely to provide binary compatibility with Symbian OS v6.1. Developers are strongly advised not to make use of this API in new applications. In particular, use the other overload of this function if you need to distinguish between leading and trailing edge positions.
Do not use if a CTextView object owns this CTextLayout object.
| Parameters | |
|---|---|
| aDocPos | A valid document position. |
| aYPos | The y coordinate at which to display the character at aDocPos. On return, contains the actual vertical position of the specified part of the line. |
| aYPosQualifier | Controls which part of the line is set to appear at aYPos. |
| aDiscardFormat | If ETrue (EFViewDiscardAllFormat), the text is reformatted to include aDocPos, otherwise text is formatted only as necessary when bringing new lines into the visible area. |
| void | SetWindow | ( | RWindow * | aWnd | ) |
| IMPORT_C void | SetWrapWidth | ( | TInt | aWrapWidth | ) |
Sets the wrap width. If the current format mode is screen mode (CLayoutData::EFScreenMode) aWrapWidth is in pixels, otherwise it is in twips.
The text needs to be reformatted after a call to this function.
Note:
A valid wrap width (>0) must be supplied or the expected amount of formatting will not take place. This could lead to panics when trying to retrieve formatting information that does not exist.
| Parameters | |
|---|---|
| aWrapWidth | The wrap width in pixels or twips. |
| const CTmTextLayout & | TagmaTextLayout | ( | ) | const [inline] |
Sets aDocPos to the paragraph start and returns the amount by which aDocPos has changed, as a non-negative number.
| Parameters | |
|---|---|
| aDocPos | A document position. On return, contains the document position of the first character in the paragraph. |
| IMPORT_C TBool | Truncating | ( | ) | const |
Tests whether truncation is on (as set by SetTruncating()).
| IMPORT_C TChar | TruncatingEllipsis | ( | ) | const |
Returns the ellipsis character used when truncation is on. The value 0xFFFF (the illegal Unicode character) means that no ellipsis character is appended to truncated text.
| TInt | WrapWidth | ( | ) | const |
Returns the index of the nearest character in the document to the window coordinates specified. Sets aPos to the actual position of the intersection of the line's baseline with the character's edge. If aPos is before the start of the formatted area, returns the first formatted character; if it is after the end of the formatted area, returns the position after the last formatted character, or the end of the document, whichever is less.
This function is deprecated in v7.0s. Use the more powerful FindXYPos() instead.
| Parameters | |
|---|---|
| aPos | Contains coordinates to convert to a document position. On return, contains the exact coordinates of the intersection of the line's baseline with the character edge at the document position. |
| aFlags | Three possible values: 0 is the default, and performs the task at full accuracy (the function returns the document position of the character edge nearest to the coordinates). CLayoutData::EFWholeLinesOnly examines lines only and returns the position at the right end of the line if aPos.iX > 0, otherwise the position at the left end. |
| IMPORT_C TInt | YBottomLastFormattedLine | ( | ) | const |
Returns the y coordinate of the bottom of the last formatted line, relative to the top of the visible region.