This function should not be used. This function is used in TTextView to test a fix for a defect.

Finds the base line height of the cursor pos

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

Removes a selection, and redraws the affected part of the screen.

Any background formatting is forced to complete first.

CheckHorizontalScroll's job is to take the cursor position in aDocPos and ensure it is visible in the view. It does this by calculating the horizontal scroll neccessary and adjusts the iTextStartX (left text margin) attribute of the view member iDrawTextLayoutContext. This change (if any) would be reflected in the next re-draw.

This functionality is required when the layout is in non-screen/window wrapped mode (ie. wysiwyg mode) and the cursor is out of view to the left or the right (say if the user has horizontally scrolled) and either a cursor movement happens or a char is inserted or deleted by the user. The end result is the view jumps back to the cursor so the user can see when change/movement was made.

When the layout format is set to screen mode this functionality may still be required as paragraphs with wrapping turned off can break the margins. Even with wrapping turned on, spaces and hanging characters can break margins; however it is usually considered ugly to allow the screen to scroll to follow the cursor in these situations.

Scrolls the screen up if necessary following background formatting. Enters OOM state before leaving

Clears the specified number of pixels from the bottom of the screen. Enters OOM state before leaving.

Un-draws a selection, redraws the affected part of the screen. The cursor selection remains as before. Analogous to CancelSelectionL(), but leaves the cursor selection untouched. This function should be called before calling CTextView::SetPendingSelection() _and_ SetHighlightExtensions has been used to extend the size of the highlight. Any background formatting is forced to complete first.

Draws text from aFrom to aTo.

Enters OOM state before leaving.

Draws good parts of the screen that have recently been formatted by background formatting. Enters OOM before leaving.

Draws the text, using an offscreen bitmap to avoid flicker if possible. All text drawing is done by this function except in printing.

Does not enter OOM state.

Discards and reformats keeping the cursor at the same height on the screen if possible. Enters OOM state before leaving

Gets the window coordinates of the character located at the specified document position. If the document position specified has not been formatted, the function returns a value of false.

Used to correct the display after a cursor move type call Enters OOM before leaving

Draws the text to a rectangle. Enters OOM state before leaving. RWindow::BeginRedraw() should always be called before calling this function, for the window that the textview draws to.

Draws the text to a rectangle.

Draw to a specific GC rather than the stored one. This is essential when drawing CTextView objects that are embedded inside others, as happens for editable text controls in WEB (the outermost WEB object is a CTextView, which has embedded controls that own CEikEdwins, and these own CTextView objects).

Draws the text. Depending on the opaque mode ("iDrawOpaque" value) and graphics context type, the method calls either DoDrawTextSupportL() or DoDrawTextSupportOpaqueL(). The additional graphics context type check has to be done, because currently only CWindowGc graphics context implementation supports opaque drawing.

Does not enter OOM state.

Sets whether a picture frame should be displayed when the text cursor is located at a picture character.

Note:

If a picture frame is currently displayed, and aEnabled is EFalse, a redraw takes place, so that the frame is removed.

Finds the x-y position of the document position aDocPos.

If aDocPos is formatted, TRUE is returned and aPosInfo returns information about the document position and aLineInfo returns information about the line containing the document position, if it is non-null.

Gets the document position of of the nearest character edge to the window coordinates specified.

Forces completion of background formatting.

This is called automatically by all CTextView functions which depend on the formatting being up to date.

Reformats the whole document, or just the visible text, if formatting is set to the band only (see CTextLayout::SetAmountToFormat()).

Notes:

Reformatting the entire document may be time consuming, so only use this function if necessary.

This function does not redraw the reformatted text.

Returns a selection for which characters should be deleted in a backwards delete.

Gets the cursor position as a TTmDocPos.

Returns a selection for which characters should be deleted in a forwards delete.

Gets the origin of the cursor.

Gets the bounding rectangle of the picture, if any, located at the document position or x,y 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 true if the operation was successful. Returns false otherwise; that is, if there is no picture at the position, or if the position is unformatted.

Returns EFalse if the specified position is not contained within a formatted picture.

Reformats and redraws to reflect the addition of one or more complete paragraphs at the end of the text. For instance, it may be used where information is being found by an active object and appended to a document.

Note:

This function should not be used to handle the situation where text is added to the final paragraph. In this case, use HandleInsertDeleteL() or HandleCharEditL() instead.

Reformats after a change to part of the text contents. Enters OOM state before leaving.

Reformats and redraws the view in response to a single key press. The precise amount of text to be reformatted is controlled by the second parameter.

Reformats and redraws the view after a global change has been made to the layout. Examples of global layout changes include changing the format mode, the wrap width, or the visibility of nonprinting characters.

Forces any background formatting to complete.

Reformats the view after a global change has been made to the layout, but without causing a redraw. Examples of global layout changes include changing the format mode, the wrap width, or the visibility of nonprinting characters.

Forces any background formatting to complete.

Reformats and redraws the view after inserting, deleting or replacing a block of text.

Can be used in combination with SetPendingSelection() to set a selection which should remain after the function has returned.

Notes:

If inserting or deleting a single character, use CTextView::HandleCharEditL() instead.

A panic occurs if partial lines are excluded from the view (see CTextLayout::ExcludingPartialLines()).

Reformats and redraws the view after changes to the character or paragraph formatting of a block of text. Reformatting can take place either from the start of the line or the start of the paragraph containing the cursor position, depending on aFormatChanged.

Can be used in combination with SetPendingSelection() to set a selection which should remain after the function has returned.

Note:

A panic occurs if partial lines are excluded from the view (see CTextLayout::ExcludingPartialLines()).

Any background formatting is forced to complete first.

Gets the number of pixels by which a horizontal scroll jump will cause the view to scroll. On construction, the default horizontal scroll jump value is set to 20 pixels.

Called when system is idle. Use to do background formatting. Enters OOM state before leaving

Tests whether there is a picture with a picture frame at the current cursor position. If there is, the aPictureFrameRect and aDocPos arguments are set to contain the picture frame rectangle and the document position of the picture, respectively.

Returns a pointer to the text layout object used by the text view.

Gets the left text margin width in pixels.

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

CCoeControl::MakeVisible()

Gets the label and line cursor margin widths in pixels.

Sets the height and ascent of the text cursor to the values contained in aFontSpec and redraws it.

Note:

The values set by this function are temporary. If the cursor is subsequently moved, it reverts to being based on the preceding character (unless at the start of a paragraph, in which case, it is based on the following character).

Sets the height and ascent of the text cursor to be the same as an adjacent character and redraws it. By default, the values are set to be based on the preceding character.

Moves the text cursor in the direction and manner specified. If necessary, the view is scrolled so that the line containing the new cursor position is visible.

Any background formatting is forced to complete first.

Allocates and constructs a CTextView object.

Formats the next line for background formatting, returns True if more to do Enters OOM state before leaving

Return True if successfully recovered from being out of memory Enters OOM before leaving

Enters the OOM state.

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.

Make an attempt to recover from no system memory Enters OOM before leaving

Shows or hides the picture frame at specified location, redrawing the picture frame rect. It assumes that: 1)iCursorPos.iFlags has been correctly updated to specify the visibility of the picture frame. 2)the picture frame object has been created and initialised. 3)Gc has already been activated. Enters OOM before leaving.

Scrolls the view either horizontally or vertically and does a redraw.

Any background formatting is forced to complete first.

Scroll the display and redraw the missing lines.

Scrolls the view vertically by a number of wholly or partially visible lines, disallowing blank space at the bottom of the visible area if aScrollBlankSpace is CTextLayout::EFDisallowScrollingBlankSpace. Redraws the newly visible lines.

Any background formatting is forced to complete first.

Scrolls the view by a number of wholly or partially visible paragraphs disallowing blank space at the bottom of the visible area if aScrollBlankSpace is CTextLayout::EFDisallowScrollingBlankSpace. Redraws the newly visible paragraphs.

Any background formatting is forced to complete first.

Scrolls the view vertically by a number of pixels, disallowing blank space from scrolling into the bottom of the visible area. Redraws the newly visible lines.

Any background formatting is forced to complete first.

Scrolls the view vertically by a number of pixels, allowing blank space from scrolling into both top and bottom of the visible area, which means the scrolling can go beyond the top or bottom border. Redraws the newly visible lines.

Any background formatting is forced to complete first.

Scroll part of the view rect

Scroll part of the view rect.

Scroll the display below point aFrom by aScrollX.

aScrollY>0 ==> text moves down.

aScrollX>0 ==> text moves right.

aFrom is relative to the text area of the window.

aScrollBackground determines whether the background can scroll along with the text.

Enters OOM before leaving

Gets the current selection.

Returns if the selection is currently visible.

In particular, the selection is invisible if the text color has been overridden.

Sets the background colour for the view rectangle.

Does not redraw.

Sets the flashing state of the text cursor and redraws it.

Sets the text cursor's placement (its shape and position relative to the insertion position) and redraws it.

This method allows clients of CTextView to provided a cursor positioning hint (as defined in TCursorPosition::TPosHint) to the Cursor Navigation Policy object currently in use in this view.

Sets the visibility of the line and text cursors.

Notes:

A group window must have been provided before a text cursor can be drawn.

Before making the line cursor visible, a line cursor bitmap must have been provided (see SetLineCursorBitmap()).

Sets the weight of the text cursor and redraws it.

If the cursor's placement is vertical (ECursorVertical), the weight is the width of the cursor. If the placement is horizontal, the weight is the height of the cursor. Has no effect if the weight value specified is zero or less.

Sets the text cursor's type and weight and redraws it. If the cursor's placement is vertical (ECursorVertical), the weight is the width of the cursor. If the placement is horizontal, the weight is the height of the cursor.

Sets the text cursor's colour and redraws it. The cursor is drawn using an Exclusive OR draw mode which ensures that the cursor's colour is different from the background colour.

Changes the window server handles which the display uses. Any of the parameters can be NULL in which case they are not changed.

Moves the text cursor to a new document position. The view is scrolled so that the line containing the new cursor position is at the top, or the bottom, if the scroll direction was downwards.

Any background formatting is forced to complete first.

Moves the text cursor to a new document position. The view is scrolled so that the line containing the new cursor position is at the top, or the bottom, if the scroll direction was downwards.

Any background formatting is forced to complete first.

Moves the text cursor to a new document position. The view is scrolled so that the line containing the new cursor position is at the top, or the bottom, if the scroll direction was downwards.

Any background formatting is forced to complete first.

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.

Sets the selection highlight to have its edges moved by the specified number of pixels. Problems with highlights appearing in the wrong place may be due to incorrect font metrics, and would not be fixed in general with a call to this function.

Sets the number of pixels by which a horizontal scroll jump will cause the view to scroll. To carry out a horizontal scroll, use ScrollDisplayL().

Sets the pending horizontal text cursor position. This is the horizontal coordinate to which the text cursor is moved after a scroll up or down by a line or a page.

Changes the text layout object used by the text view.

Sets the left text margin width in pixels.

The left text margin width is the distance between the text and the left edge of the page. Increasing the left text margin width causes text to move leftwards and decreasing the left text margin width causes text to move rightwards.

Does not redraw.

Sets the bitmap to be used as a line cursor. This function must be called before attempting to draw the line cursor. Use SetCursorVisibilityL() to make the line cursor visible.

Sets the label and line cursor margin widths.

Does not redraw.

Sets a text view observer. This provides notification to the owner of the text view object of changes to the formatting. Its OnReformatL() function is called after reformatting but before redisplay, so that edit windows etc. can be resized.

Sets and unsets an opaque flag on the text view's window.

Sets the horizontal extent of the view rectangle to fill with paragraph fill colour (CParaFormat::iFillColor).

Does not redraw.

Makes a selection, but without updating the view.

This function would only be used before calling CTextView::HandleRangeFormatChangeL() or HandleInsertDeleteL() to make a selection which will become visible (if selection visibility is on) after the change handling function has returned.

Sets a selection. The selection is highlighted unless selection visibility has been unset. Any existing selection is cancelled. If necessary, the view is scrolled and redrawn.

Any background formatting is forced to complete first.

Sets whether the text and pictures within a selection should be highlighted. If necessary, the view is redrawn.

An example of when this function may need to be used is when a control loses or gains focus.

Overrides the text colour, so that when redrawn, all text has the colour specified, rather than the colour which is set in the text object. When text is in this overridden state, no highlighting is visible. To return the text colour to its original state, call this function again with an argument of NULL. This also has the effect that if selection visibility is set, any highlighting will be made visible again.

Does not do a redraw.

Sets the vertical position of the view, so that the line containing aDocPos is located as close as possible to the vertical window coordinate aYPos.

Which part of the line is set to appear at aYPos (top, baseline, or bottom) is controlled by aYPosQualifier, which also specifies whether the visible area is to be filled and whether the line should be made fully visible if possible.

Moves the view vertically and redraws, so that the top of the specified line is located flush with the top of the view rectangle.

Note:

Line numbering is relative to formatted text only and the first formatted line is numbered one.

Sets the rectangle in which the text is displayed.

Note:

A valid band height (>0) must be supplied(i.e. aViewRect.Tl.iY coordinate must be lower than the aViewRect.Br.iY coordinate) 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.

Moves the text cursor to the nearest point on the screen to the x,y coordinates specified.

Any background formatting is forced to complete first.

Starts the Idle Object if not in the middle of drawing para borders.

Gets called after the cursor moved to a picture, creates the picture frame if it has not been created and updates its state.

Gets the rectangle in which the text is displayed.

Calculates which of two document positions would be considered more left or more right, depending on the value of aDirection.

Gets the index of the nearest character in the document to the window coordinates specified. The function first identifies the line which contains, or is nearest to, the vertical coordinate. Then it identifies the character in that line closest to the horizontal coordinate.

deprecated 8.0

Cursor height matching.

Passed as an argument to MatchCursorHeightToAdjacentChar().

Whether to reformat and redraw. Argument to SetViewL().