Returns the left and right extremes, in layout coordinates, of the formatted text.

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.

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.

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.

Tests whether partial lines at the top and bottom of the view are currently excluded.

7.0

Makes sure the line that aYPos is in (if it exists) is covered by the formatting.

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.

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.

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.

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

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

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.

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.

SetBandHeight SetWrapWidth

Gets the width and height of the bounding box of the text, including indents and margins, when formatted to the specified wrap width.

Finds the next cursor position to aDocPos in the visually ordered line.

Reformats to reflect changes to a block of text.

Do not use if a CTextView object owns this CTextLayout object.

Reformats to reflect a single character edit.

Do not use if a CTextView object owns this CTextLayout object.

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.

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.

Tests whether wrapping is on or off.

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.

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

CCoeControl::MakeVisible()

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.

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.

Gets the number of formatted lines.

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.

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.

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.

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.

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.

Returns the number of fully or partially visible characters in the visible band.

Reformats to reflect changes to the space above and below paragraphs (CParaFormat::iSpaceBeforeInTwips and iSpaceAfterInTwips).

Do not use if a CTextView object owns this CTextLayout object. 6.1 Use FormatBandL()

Cleanup method for the opaque flag.

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.

Scroll aDy pixels (positive = text moves down); return number of pixels actually scrolled. Create a new formatted band if necessary.

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.

Allows Form clients to register an invisible character remapper object to customize the visible display of invisible characters such as paragraph marks.

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.

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

7.0

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.

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

Sets offsets for the edges of the selection highlight.

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.

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.

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.

Sets the layout object's source text to aDoc.

The text needs to be reformatted after a call to this function.

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.

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

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.

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

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.

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.

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.

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.

Finds a position (in pixels, from the top of the window) where the cursor can be such that its line will be fully visible. If this is not possible, then return one with its baseline visible. If this is not possible, we don't care what the answer is.

Sets aDocPos to the paragraph start and returns the amount by which aDocPos has changed, as a non-negative number.

Tests whether truncation is on (as set by SetTruncating()).

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.

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.

Returns the y coordinate of the bottom of the last formatted line, relative to the top of the visible region.

Indicates whether blank space should scroll. Used by several CTextView and CTextLayout scrolling functions.

Amount to format. Used by CTextLayout::SetAmountToFormat().

Formatting information.

Flags used by CTextLayout::SetViewL(). Whether to reformat and redraw.