Construct an empty object with no text and zero width and height. It is legal to call all CTmTextLayout functions on an empty object, with the exception of AddParL and FormatL, which panic with ENoSource.

The destructor.

Format a new paragraph immediately before or after the band and add it to the formatted text. If the text starts or ends in the middle of the paragraph, complete the paragraph. Return TRUE if text was successfully added, or FALSE if there is no more text to add, or the new text would have exceeded the maximum height allowed. Place the height of the new text in aHeightIncrease. Place the increase in the number of complete paragraphs (0 or 1) in aParagraphsIncrease.

Note that this function will not necessarily add a whole paragraph to the band: if the client has restricted the amount of formatting to add by setting the relevant values in aParam, then these restrictions will be respected with the result that less than a paragraph of formatting may be generated.

This is the case, for example, when CTextLayout adds text below the band.

Reset the object to its empty state; no source or formatting, height and width of 0, start and end char both 0.

Returns a reference to the CTmCode object containing the bytecode representing the text layout.

Delete as many lines of formatting as possible from the end of the formatted range, up to the maximum height specified in aMaxDeletedHeight. The height decrease is placed in aHeightDecrease.

Delete the format for the first or last paragraph if its height does not exceed aMaxDeletedHeight. Return TRUE if a paragraph was successfully deleted. Place the height of the deleted paragraph in aHeightDecrease.

Returns information (including line number and formatting information) of the line containing a given document position.

Retrieve information about the line containing a certain document position. Put information about the line containing aDocPos in aLineInfo. Return FALSE if aDocPos is not in the formatted text. 7.0s

Draw the background, using the custom background graphics implemented by overriding MTmSource::DrawBackground if any: aTopLeft is the top-left corner of the text, aRect is the portion of the background to be drawn, and aBackground is the default background colour. This function is used by higher-level classes for drawing backgrounds outside the ordinary text area consistently with the ordinary background.

Draw the text.

Draw the text.

Analogous to DrawSection( CGraphicsContext &, const TPoint &, TInt, TInt, const TRect &) but with highlight extensions applied. DrawSection(CGraphicsContext&, const TPoint&, TInt, TInt, const TRect&)

Returns the character after the last formatted character.

Returns the chunks of text adjacent to aPos.

Finds a document position and returns information about it and the line it is in.

Find a document position and return information about it and the line it is in. Return FALSE if the document position is outside the formatted text. The document position to be found is passed in aDocPos and the information about the position found is returned in aPosInfo. The line information is returned in aLineInfo. 7.0s

Finds a document position and returns information about it and the line it is in.

Finds the position after the horizontally spacing element after aStart. A horizontally spacing element is a spacing glyph (such as a letter or number) plus all its combining accent, or other spacing character such as a tab or carriage return. This function will also skip any zero-width characters that precede the next horizontally spacing element.

Finds the position before the horizontally spacing element before aStart. Zero-width characters immediately before aStart are also skipped. FindNextPos

Finds a document position (i.e. the edge between two adjacent characters) by x-y position relative to the top-left corner of the formatted text.

Find an x-y position, relative to the top-left corner of the text, and return information about it and the line it is in. Return FALSE if the position is outside the formatted text. The document position to be found is passed in aDocPos and the information about the position found is returned in aPosInfo. The line information is returned in aLineInfo. 7.0s

Finds information about the visual position closest to the point specified. If there are two positions at this place that represent the ends of blocks that are not logically contiguous, different positions representing the ends of these blocks are returned. there is an ambiguity at this position, the document positions that represent the ends of the different blocks that meet here are returned.

Format part of the text that has changed and indicate whether further formatting needs to be done.

The backing text must remain constant during background formatting. What this means is that if background formatting is enabled ( TTmReformatParam::iMaxExtraLines is some small number, causing formatting to end mid-way with TTmReformatResult::iUnformattedStart less than KMaxTInt), so that text can be formatted bit by bit by a higher-level object, as is done by CTextView, the backing text must not change between the series of calls to this function that make up a single reformatting act.

Returns metrics for the cursor suitable for the document position and placement specified, as well as information about the line containing the position specified.

Return cursor metrics suitable for the supplied document position and placement. The cursor is defined like a character, with an origin, width, height and depth. This allows the caller to preserve the origin while overriding the other metrics. 7.0s

Retrieve the text as displayed on a particular line. Return FALSE if the operation is impossible (e.g., because no MTmSource has yet been assigned). The text is returned in aText. The number of characters needed, which may be greater than the size of aText, is placed in aNeeded.

The text will be returned in display order, after all transformations have been applied to the backing text. These transformations include bidirectional reordering (making Arabic and Hebrew go right to left, etc.), ligation (combining adjacent characters into a single glyph), suppressing control characters, and converting characters to visible forms like visible spaces if necessary. 7.0 It can fail due to environmental conditions, and should therefore be leavable. Use GetDisplayedTextL instead.

Retrieve the text as displayed on a particular line.

The text will be returned in display order, after all transformations have been applied to the backing text. These transformations include bidirectional reordering (making Arabic and Hebrew go right to left, etc.), ligation (combining adjacent characters into a single glyph), suppressing control characters, and converting characters to visible forms like visible spaces if necessary.

Precondition: SetTextL must have been called on this object before GetDisplayedText can be called.

Please note that any text that has passed through a shaper (for example Devanagari text) will be replaced in the returned text with the Unicode Replacement Character 0xFFFD. This is because the shaper produces glyph codes, not Unicode characters, and this is because Unicode does not contain all the ligatures and glyph variants required to display such scripts correctly.

Get the size of the minimal bounding box of the text when formatted to the specified wrap width. The width may be greater than aWrapWidth. To find the minimum width for the text, pass 0 for aWrapWidth. To find the minimum height, pass KMaxTInt for aWrapWidth.

Get the size of the minimal bounding box of the text when formatted to the specified wrap width. The width may be greater than aWrapWidth. To find the minimum width for the text, pass 0 for aWrapWidth. To find the minimum height, pass KMaxTInt for aWrapWidth. Use aAllowLegalLineBreaksOnly to set whether or not illegal line breaks should be considered when determining aSize.

Finds information about the position visually to the left of the position specified, as long as it is on the same line. If there are two positions at this place that represent the ends of blocks that are not logically contiguous, different positions representing the ends of these blocks are returned.

Finds information about the position visually to the right of the position specified, as long as it is on the same line. If there are two positions at this place that represent the ends of blocks that are not logically contiguous, different positions representing the ends of these blocks are returned.

Find the nearest document position to the current one in the visual direction specified. This only works if the document position is within formatted text. False is returned if this condition is not met.

Get the next cursor position in visual order. This function is useful for text that contains Arabic, Hebrew, or other right-to-left languages because it allows the cursor to be moved right or left on the display whatever the order of the backing text.

The cursor position to the left or right of aDocPos is found, depending on the value of aToLeft. Information about the resulting position is returned in aInfo. The function returns TRUE if successful, FALSE if not. A FALSE return value means that there is no text, or aDocPos is outside the formatted text, or aDocPos cannot move in the required direction because it is at the end of the line. 7.0s

Calculate the bounding rectangle of the region that must be redrawn to redraw the given document section.

Analogous to HighlightSection( CGraphicsContext &, const TPoint &, TInt, TInt, const TRect &) but with highlight extensions applied. HighlightSecion( CGraphicsContext &, const TPoint &, TInt , TInt , const TRect &)

Analogous to InvertLayout(CGraphicsContext, const TPoint&, TInt, TInt) but with highlight extensions applied. InvertLayout(CGraphicsContext, const TPoint&, TInt, TInt)

Returns the height in pixels of the formatted text.

Return the width in pixels of the formatted text, not including paragraph labels if present.

Returns the position at the left or right extreme of the line containing aPos.

Retrieve information about a line, referring to the line by its line number.

Put information about the line numbered aLineNumber, counting the first formatted line as 0, in aLineInfo. Return FALSE if aLineNumber is not formatted.

Return the number of formatted lines.

Stops or allows text to be drawn. Included to allow users to control visibility if text is part of an invisible control.

Return the amount of memory used by a CTmTextLayout object, The amount returned is in bytes. The amount returned does not include memory used by non-owned objects.

Retrieve information about a line, referring to the line by its paragraph number and line number within the paragraph.

Put information about line aLineNumber in paragraph aParNumber, counting the first formatted paragraph as 0, in aLineInfo. Return FALSE if aParNumber is not formatted. If aLineInPar is greater than the number of lines in the paragraph the last line in the paragraph is returned.

Return the number of formatted paragraphs.

Set the text, discarding any existing layout information. The text from aParam.iStartChar to aParam.iEndChar is extracted from aSource and formatted.

Returns a pointer to to the MTmSource object, if any, that provides text and formatting to this object. Returns null if no source object has been set.

Returns the first formatted character.

Find the width of the widest line in the specified vertical range. The width is the 'inner width'; that of the text itself not including indents or margins.

Retrieve information about a line containing a certain y coordinate.

Put information about the line containing the y coordinate aYPos, relative to 0 as the top of the formatted text, in aLineInfo. Return FALSE if aYPos is outside all formatted lines.