#include <frmtview.h>
Link against: form.lib
| class CTextView : public CBase, public CBase |
| Public Member Enumerations | |
|---|---|
| enum | anonymous { EFFirstCharOnLine, EFLastCharOnLine } |
| enum | TBeforeAfter { EFCharacterBefore, EFCharacterAfter } |
| enum | TDiscard { EFViewDiscardAllFormat, EFViewDontDiscardFormat, EFViewDiscardAllNoRedraw, EFViewDontDiscardFullRedraw } |
| enum | TDoHorizontalScroll { EFNoHorizontalScroll, EFCheckForHorizontalScroll } |
| enum | TPriorities { EFBackgroundFormattingPriority } |
Lays out formatted text for display.
The class provides functions to:
convert between document positions and x,y coordinates
set the dimensions of the rectangle in which text can be viewed (the view rectangle)
set margin widths
do horizontal and vertical scrolling
do text selection
set the cursor position and appearance
After a change has been made to the text layout, a reformat and redraw should normally take place. CTextView provides functions which are optimised to reformat the minimum amount necessary. For example, when a global formatting parameter is changed (e.g. the wrap width), the whole document's layout needs to be recalculated, so HandleGlobalChangeL() should be called. If the change involves the insertion or deletion of a single character, only a single line may be affected; for this, HandleCharEditL() is appropriate. Most CTextView reformatting functions do scrolling (using block transfer), if necessary, and a redraw.
For maximum responsiveness, CTextView uses an active object to carry out reformatting as a background task, so that the application can continue to receive user input. Many CTextView functions force background formatting to complete before they take effect.
When scrolling vertically, positive numbers of pixels, lines, paragraphs, pages, etc., mean that the text moves down, and vice versa. When scrolling horizontally, positive numbers of pixels mean that the text moves left and vice versa.
A text view can display up to two cursors and up to three margins. The cursors are the text cursor and the line cursor. The purpose of the line cursor is to make it easier to see which line the text cursor (or the selection extension point) is on. The three margins are the label margin (for paragraph labels), the line cursor margin (for the line cursor) and the left text margin (the gap between the edge of the page and the text). All are optional, but if present, they appear in that order, starting at the left edge of the view rectangle.
An object of class CTextLayout is used by the text view to calculate changes to the layout. This object must be specified when constructing the text view. It is also used to set layout attributes, including the wrap width, the height of the visible portion of the document (the "band"), whether formatting is set to the band or to the whole document and the text object which is the source of the text and formatting information.
The x-y pixel coordinates used by CTextView are called window coordinates. Window coordinates have their origin at the top left corner of the view window (unlike class CTextLayout whose coordinates have their origin at the top left corner of the area within the view rectangle in which text can appear). As in most bitmap graphics systems, x coordinates increase rightwards and y coordinates increase downwards.
deprecated 8.0
| Enumerator | Value | Description |
|---|---|---|
| EFFirstCharOnLine | -1000000 | |
| EFLastCharOnLine | 1000000 |
Cursor height matching.
Passed as an argument to MatchCursorHeightToAdjacentChar().
| Enumerator | Value | Description |
|---|---|---|
| EFCharacterBefore | ETrue |
Text cursor height is matched to preceding character. |
| EFCharacterAfter | EFalse |
Text cursor height is matched to following character. |
Whether to reformat and redraw. Argument to SetViewL().
| Enumerator | Value | Description |
|---|---|---|
| EFViewDiscardAllFormat |
Discard all formatting; redraw. | |
| EFViewDontDiscardFormat |
Do not discard all formatting; redraw. | |
| EFViewDiscardAllNoRedraw |
Discard all formatting; no redraw. | |
| EFViewDontDiscardFullRedraw |
Do not discard all formatting; redraw. |
| Enumerator | Value | Description |
|---|---|---|
| EFNoHorizontalScroll | EFalse | |
| EFCheckForHorizontalScroll | ETrue |
| Enumerator | Value | Description |
|---|---|---|
| EFBackgroundFormattingPriority | (CActive::EPriorityIdle + CActive::EPriorityLow) / 2 |
| IMPORT_C | ~CTextView | ( | ) |
| IMPORT_C void | AlterViewRect | ( | const TRect & | aViewRect | ) |
| IMPORT_C const TRect & | AlteredViewRect | ( | ) | const |
| IMPORT_C CBitmapContext * | BitmapContext | ( | ) |
This function should not be used. This function is used in TTextView to test a fix for a defect.
Returns the left and right extremes, in window 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. |
| IMPORT_C void | CancelSelectionL | ( | ) |
Removes a selection, and redraws the affected part of the screen.
Any background formatting is forced to complete first.
| IMPORT_C void | ClearSelectionL | ( | ) |
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.
| void | DisableFlickerFreeRedraw | ( | ) | [inline] |
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.
| Parameters | |
|---|---|
| aDocPos | The document position. |
| aPoint | On return, contains the window coordinates of aDocPos. This value is undefined if the position has not been formatted. |
| IMPORT_C void | DrawL | ( | TRect | aRect | ) |
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.
| Parameters | |
|---|---|
| aRect | Rectangle to which the text is drawn, normally the view rectangle. |
| IMPORT_C void | DrawL | ( | TRect | aRect, |
| CBitmapContext & | aGc | |||
| ) | ||||
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).
| Parameters | |
|---|---|
| aRect | Rectangle to which the text is drawn, normally the view rectangle. |
| aGc | Graphics context to be drawn to. Flicker-free redrawing will not be applied, so this parameter should not be a window gc if flickering is to be avoided. Notice that the fonts drawn to this context will be taken from the graphics device map given to the constructor of this object or in subsequent calls to CTextLayout::SetImageDeviceMap. If such fonts cannot be used with this bitmap context, the behaviour is undefined. |
| void | EnableFlickerFreeRedraw | ( | ) | [inline] |
| IMPORT_C void | EnablePictureFrameL | ( | TBool | aEnabled | ) |
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.
| Parameters | |
|---|---|
| aEnabled | True to enable picture frames, false to disable them. |
| IMPORT_C TBool | FindDocPosL | ( | const TTmDocPosSpec & | aDocPos, |
| TTmPosInfo2 & | aPosInfo, | |||
| TTmLineInfo * | aLineInfo = 0 | |||
| ) | ||||
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.
| Parameters | |
|---|---|
| aDocPos | The document position to investigate. |
| aPosInfo | If non-null, on return, contains information about the document position. |
| aLineInfo | If non-null, on return, contains information on the line that the position is in. |
| IMPORT_C TBool | FindXyPosL | ( | const TPoint & | aXyPos, |
| TTmPosInfo2 & | aPosInfo, | |||
| TTmLineInfo * | aLineInfo = 0 | |||
| ) | ||||
Gets the document position of of the nearest character edge to the window coordinates specified.
| Parameters | |
|---|---|
| aXyPos | The window coordinates to investigate. |
| aPosInfo | If non-null, on return contains information about the position located in the text. |
| aLineInfo | If non-null, on return contains information on the line that the position is in. |
| IMPORT_C void | FinishBackgroundFormattingL | ( | ) |
Forces completion of background formatting.
This is called automatically by all CTextView functions which depend on the formatting being up to date.
| TBool | FlickerFreeRedraw | ( | ) | const [inline] |
| IMPORT_C void | FormatTextL | ( | ) |
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.
| IMPORT_C TCursorSelection | GetBackwardDeletePositionL | ( | ) |
Returns a selection for which characters should be deleted in a backwards delete.
| IMPORT_C TCursorSelection | GetForwardDeletePositionL | ( | ) |
Returns a selection for which characters should be deleted in a forwards delete.
| void | GetOrigin | ( | TPoint & | aPoint | ) | const [inline] |
Gets the origin of the cursor.
| Parameters | |
|---|---|
| aPoint | On return, the cursor origin. |
| IMPORT_C TBool | GetPictureRectangleL | ( | TInt | aDocPos, |
| TRect & | aPictureRect, | |||
| TBool * | aCanScaleOrCrop = 0 | |||
| ) | const | |||
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.
| 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 true, indicates whether the picture can be scaled or cropped. By default, null. |
Returns EFalse if the specified position is not contained within a formatted picture.
| IMPORT_C void | HandleAdditionalCharactersAtEndL | ( | ) |
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.
| IMPORT_C TInt | HandleCharEditL | ( | TUint | aType = CTextLayout::EFCharacterInsert, |
| TBool | aFormatChanged = EFalse | |||
| ) | ||||
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.
| 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 cursor position. |
| 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 | HandleGlobalChangeL | ( | TViewYPosQualifier | aYPosQualifier = TViewYPosQualifier() | ) |
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.
| Parameters | |
|---|---|
| aYPosQualifier | Specifies whether the visible area is to be filled and whether the top line should be made fully visible if possible. |
| IMPORT_C void | HandleGlobalChangeNoRedrawL | ( | TViewYPosQualifier | aYPosQualifier = TViewYPosQualifier() | ) |
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.
| Parameters | |
|---|---|
| aYPosQualifier | Specifies whether the visible area is to be filled and whether the top line should be made fully visible if possible. |
| IMPORT_C TPoint | HandleInsertDeleteL | ( | TCursorSelection | aSelection, |
| TInt | aDeletedChars, | |||
| TBool | aFormatChanged = EFalse | |||
| ) | ||||
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()).
| Parameters | |
|---|---|
| aSelection | The start and new length of the changed block. If this function is being used to handle deletion only, this argument should be of length zero and its start position should be the beginning of the deletion. |
| aDeletedChars | The number of deleted characters. Specify zero if this function is being used to handle insertion only. |
| 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 TPoint | HandleRangeFormatChangeL | ( | TCursorSelection | aSelection, |
| TBool | aFormatChanged = EFalse | |||
| ) | ||||
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.
| Parameters | |
|---|---|
| aSelection | Indicates the text range which has been reformatted. |
| 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 TInt | HorizontalScrollJump | ( | ) | const |
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.
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.
| Parameters | |
|---|---|
| aPictureFrameRect | If the function returns true, on return contains the picture frame rectangle. |
| aDocPos | If the function returns true, on return contains the document position of the picture. |
| const CTextLayout * | Layout | ( | ) | const [inline] |
Returns a pointer to the text layout object used by the text view.
| IMPORT_C TInt | LeftTextMargin | ( | ) | const |
Gets the left text margin width in pixels.
| 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 void | MatchCursorHeightL | ( | const TFontSpec & | aFontSpec | ) |
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).
| Parameters | |
|---|---|
| aFontSpec | Specifies a height and ascent to which to set the text cursor. |
| IMPORT_C void | MatchCursorHeightToAdjacentChar | ( | TBeforeAfter | aBasedOn = EFCharacterBefore | ) |
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.
| Parameters | |
|---|---|
| aBasedOn | EFCharacterBefore to base the height and ascent of the text cursor on the preceding character. EFCharacterAfter to base them on the following character. |
| IMPORT_C TPoint | MoveCursorL | ( | TCursorPosition::TMovementType & | aMovement, |
| TBool | aDragSelectOn | |||
| ) | ||||
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.
| Parameters | |
|---|---|
| aMovement | The direction and manner in which to move the cursor. On return set to the actual cursor movement. The actual cursor movement may be different from the one requested if for example the desired cursor movement is upwards and the cursor is already on the top line. In this case, this argument will return TCursorPosition::EFLineBeg. A return value of TCursorPosition::EFNoMovement indicates that no cursor movement took place. |
| aDragSelectOn | ETrue if the region between the old and new cursor positions should be selected, EFalse if not. If ETrue, any existing selection remains selected, so that this function can be used to extend or shorten a selected region. EFalse cancels any existing selection. |
| IMPORT_C CTextView * | NewL | ( | CTextLayout * | aLayout, |
| const TRect & | aDisplay, | |||
| CBitmapDevice * | aGd, | |||
| MGraphicsDeviceMap * | aDeviceMap, | |||
| RWindow * | aWin, | |||
| RWindowGroup * | aGroupWin, | |||
| RWsSession * | aSession | |||
| ) | [static] | |||
Allocates and constructs a CTextView object.
| Parameters | |
|---|---|
| aLayout | Pointer to the layout object referenced by the text view. Must not be NULL or a panic occurs. |
| aDisplay | The rectangle in which text is displayed (the "view rectangle"). |
| aGd | Bitmapped graphics device to draw to, e.g. the screen. |
| aDeviceMap | The device map used for drawing and formatting. |
| aWin | The window to draw to. Should not be NULL. |
| aGroupWin | Window group. Must be provided if a text cursor is to be displayed. It can be NULL if you don't need a text cursor. |
| aSession | Pointer to the window server session. |
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. |
| IMPORT_C TInt | ScrollDisplayL | ( | TCursorPosition::TMovementType | aMovement, |
| CTextLayout::TAllowDisallow | aScrollBlankSpace = CTextLayout::EFDisallowScrollingBlankSpace | |||
| ) | ||||
Scrolls the view either horizontally or vertically and does a redraw.
Any background formatting is forced to complete first.
| Parameters | |
|---|---|
| aMovement | Controls the direction and the amount of scroll. |
| aScrollBlankSpace | CTextLayout::EFAllowScrollingBlankSpace allows blank space to scroll into the visible area (applies when scrolling horizontally as well as vertically), CTextLayout::EFDisallowScrollingBlankSpace prevents blank space from scrolling into the visible area. |
| IMPORT_C TInt | ScrollDisplayLinesL | ( | TInt & | aDeltaLines, |
| CTextLayout::TAllowDisallow | aScrollBlankSpace = CTextLayout::EFDisallowScrollingBlankSpace | |||
| ) | ||||
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.
| Parameters | |
|---|---|
| aDeltaLines | The number of lines to scroll; may be a positive or negative value. Positive values move the text down, negative move it up. 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 | ScrollDisplayParagraphsL | ( | TInt & | aDeltaParas, |
| CTextLayout::TAllowDisallow | aScrollBlankSpace = CTextLayout::EFDisallowScrollingBlankSpace | |||
| ) | ||||
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.
| Parameters | |
|---|---|
| aDeltaParas | The number of paragraphs to scroll; may be a positive or negative value; positive values move the text down, negative move it up. 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 | ScrollDisplayPixelsL | ( | TInt & | aDeltaY | ) |
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.
| Parameters | |
|---|---|
| aDeltaY | The number of pixels to scroll; may be a positive or negative value. On return, contains the number of pixels actually scrolled. Positive values move the text down, negative move it up. |
| IMPORT_C void | ScrollDisplayPixelsNoLimitBorderL | ( | TInt | aDeltaY | ) |
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.
| Parameters | |
|---|---|
| aDeltaY | The number of pixels to scroll; may be a positive or negative value. On return, contains the number of pixels actually scrolled. Positive values move the text down, negative move it up. |
| IMPORT_C TCursorSelection | Selection | ( | ) | const |
Gets the current selection.
| IMPORT_C TBool | SelectionVisible | ( | ) | const |
Returns if the selection is currently visible.
In particular, the selection is invisible if the text color has been overridden.
| IMPORT_C void | SetBackgroundColor | ( | TRgb | aColor | ) |
Sets the background colour for the view rectangle.
Does not redraw.
| Parameters | |
|---|---|
| aColor | The background colour. |
| IMPORT_C void | SetCursorFlash | ( | TBool | aEnabled | ) |
Sets the flashing state of the text cursor and redraws it.
| Parameters | |
|---|---|
| aEnabled | ETrue for a flashing cursor, EFalse for a non-flashing cursor. |
| IMPORT_C void | SetCursorPlacement | ( | TTmCursorPlacement | aPlacement | ) |
Sets the text cursor's placement (its shape and position relative to the insertion position) and redraws it.
| Parameters | |
|---|---|
| aPlacement | The text cursor's placement |
| IMPORT_C void | SetCursorPositioningHintL | ( | TCursorPosition::TPosHint | aHint | ) |
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.
| Parameters | |
|---|---|
| aHint | Cursor position hint provided by client of CTextView. |
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()).
| Parameters | |
|---|---|
| aLineCursor | Sets whether the line cursor should be displayed. For possible values, see the TCursor::TVisibility enumeration. |
| aTextCursor | Sets whether the text cursor should be displayed and if so, whether it should flash. For possible values, see the TCursor::TVisibility enumeration. |
| IMPORT_C void | SetCursorWeight | ( | TInt | aWeight | ) |
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.
| Parameters | |
|---|---|
| aWeight | The weight in pixels of the text cursor. |
| IMPORT_C void | SetCursorWidthTypeL | ( | TTextCursor::EType | aType, |
| TInt | aWidth = 0 | |||
| ) | ||||
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.
| Parameters | |
|---|---|
| aType | The text cursor type. |
| aWidth | The weight in pixels of the text cursor. Specify zero (the default) to leave the current weight unchanged. |
| IMPORT_C void | SetCursorXorColor | ( | TRgb | aColor | ) |
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.
| Parameters | |
|---|---|
| aColor | The text cursor's colour. |
| IMPORT_C void | SetDisplayContextL | ( | CBitmapDevice * | aGd, |
| RWindow * | aWin, | |||
| RWindowGroup * | aGroupWin, | |||
| RWsSession * | aSession | |||
| ) | ||||
Changes the window server handles which the display uses. Any of the parameters can be NULL in which case they are not changed.
| Parameters | |
|---|---|
| aGd | Pointer to the bitmapped graphics device to draw to. |
| aWin | Pointer to the view window. |
| aGroupWin | Pointer to the window group. |
| aSession | Pointer to the window server session. |
| IMPORT_C TPoint | SetDocPosL | ( | const TTmDocPosSpec & | aDocPos, |
| TBool | aDragSelectOn = EFalse | |||
| ) | ||||
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.
| Parameters | |
|---|---|
| aDocPos | The new document position of the text cursor. |
| aDragSelectOn | ETrue if the region between the old and new cursor positions should be selected, EFalse if not. If ETrue, any existing selection remains selected, so that this function can be used to extend or shorten a selected region. EFalse cancels any existing selection. |
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.
| Parameters | |
|---|---|
| aDocPos | The new document position of the text cursor. |
| aDragSelectOn | ETrue if the region between the old and new cursor positions should be selected, EFalse if not. If ETrue, any existing selection remains selected, so that this function can be used to extend or shorten a selected region. EFalse cancels any existing selection. |
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.
| Parameters | |
|---|---|
| aDocPos | The new document position of the text cursor. |
| aDragSelectOn | ETrue if the region between the old and new cursor positions should be selected, EFalse if not. If ETrue, any existing selection remains selected, so that this function can be used to extend or shorten a selected region. EFalse cancels any existing selection. |
| IMPORT_C 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 | SetHighlightExtensions | ( | TInt | aLeftExtension, |
| TInt | aRightExtension, | |||
| TInt | aTopExtension, | |||
| TInt | aBottomExtension | |||
| ) | ||||
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.
| Parameters | |
|---|---|
| aLeftExtension | Number of pixels to the left to move the left of the highlight. |
| aRightExtension | Number of pixels to the right to move the right of the highlight. |
| aTopExtension | Number of pixels to the up to move the top of the highlight. |
| aBottomExtension | Number of pixels to the down to move the bottom of the highlight. |
| IMPORT_C void | SetHorizontalScrollJump | ( | TInt | aScrollJump | ) |
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().
| Parameters | |
|---|---|
| aScrollJump | The number of pixels by which a horizontal scroll jump will cause the view to scroll. Must be a positive value or a panic occurs. |
| IMPORT_C void | SetLatentXPosition | ( | TInt | aLatentX | ) |
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.
| Parameters | |
|---|---|
| aLatentX | The horizontal coordinate to which the text cursor should be moved after a line or page scroll. |
| IMPORT_C void | SetLayout | ( | CTextLayout * | aLayout | ) |
Changes the text layout object used by the text view.
| Parameters | |
|---|---|
| aLayout | Pointer to the text layout object used by the text view. Must not be NULL or a panic occurs. |
| IMPORT_C void | SetLeftTextMargin | ( | TInt | aLeftMargin | ) |
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.
| Parameters | |
|---|---|
| aLeftMargin | The left text margin width in pixels. |
| IMPORT_C void | SetLineCursorBitmap | ( | const CFbsBitmap * | aLineCursorBitmap | ) |
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.
| Parameters | |
|---|---|
| aLineCursorBitmap | The bitmap which represents the line cursor. |
| void | SetObserver | ( | MObserver * | aObserver | ) | [inline] |
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.
| Parameters | |
|---|---|
| aObserver | Pointer to text view observer object. |
| IMPORT_C void | SetOpaque | ( | TBool | aDrawOpaque | ) |
Sets and unsets an opaque flag on the text view's window.
| Parameters | |
|---|---|
| aDrawOpaque | If true, opaque drawing mode is switched on. If false, normal drawing will be used. |
| IMPORT_C void | SetParagraphFillTextOnly | ( | TBool | aFillTextOnly | ) |
Sets the horizontal extent of the view rectangle to fill with paragraph fill colour (CParaFormat::iFillColor).
Does not redraw.
| Parameters | |
|---|---|
| aFillTextOnly | If true, the region filled with paragraph fill colour is the area within the paragraph's bounding rectangle only (see ParagraphRectL()). If false, the filled region includes the left text margin, if one has been set. By default, false. |
| IMPORT_C void | SetPendingSelection | ( | const TCursorSelection & | aSelection | ) |
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.
| Parameters | |
|---|---|
| aSelection | The range to be selected after calling CTextView::HandleRangeFormatChangeL() or HandleInsertDeleteL(). |
| IMPORT_C TPoint | SetSelectionL | ( | const TCursorSelection & | aSelection | ) |
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.
| Parameters | |
|---|---|
| aSelection | Specifies the start and end positions of the selection. |
| IMPORT_C void | SetSelectionVisibilityL | ( | TBool | aSelectionVisible | ) |
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.
| Parameters | |
|---|---|
| aSelectionVisible | ETrue for highlighted selection. EFalse for unhighlighted selection. |
| IMPORT_C void | SetTextColorOverride | ( | const TRgb * | aOverrideColor = 0 | ) |
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.
| Parameters | |
|---|---|
| aOverrideColor | If not NULL, overrides the text colour. |
| IMPORT_C TPoint | SetViewL | ( | TInt | aDocPos, |
| TInt & | aYPos, | |||
| TViewYPosQualifier | aYPosQualifier = TViewYPosQualifier(), | |||
| TDiscard | aDiscardFormat = EFViewDontDiscardFormat, | |||
| TDoHorizontalScroll | aDoHorizontalScroll = EFCheckForHorizontalScroll | |||
| ) | ||||
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.
| Parameters | |
|---|---|
| aDocPos | The document position. Must be valid or a panic occurs. |
| aYPos | The y coordinate at which to position the character at aDocPos. On return, contains the actual vertical window coordinate at which the document position has been set. |
| aYPosQualifier | Controls which part of the line should appear at aYPos. |
| aDiscardFormat | If EFViewDiscardAllFormat or EFViewDiscardAllNoRedraw the text is reformatted to include aDocPos, otherwise text is formatted only as necessary when bringing new lines into the visible area. If EFViewDiscardAllNoRedraw, no redraw takes place. |
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.
| Parameters | |
|---|---|
| aLineNo | The number of the line to be displayed at the top of the view rectangle. |
| IMPORT_C void | SetViewRect | ( | const TRect & | aDisplay | ) |
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.
| Parameters | |
|---|---|
| aDisplay | The view rectangle. |
| IMPORT_C TPoint | SetXyPosL | ( | TPoint | aPos, |
| TBool | aDragSelectOn, | |||
| TRect *& | aPictureRect, | |||
| TInt & | aPictureFrameEdges | |||
| ) | ||||
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.
| Parameters | |
|---|---|
| aPos | The window coordinates to which to move the text cursor. |
| aDragSelectOn | ETrue if the region between the old and new cursor positions should be selected, EFalse if not. If ETrue, any existing selection remains selected, so that this function can be used to extend or shorten a selected region.EFalse cancels any existing selection. |
| aPictureRect | On return, a pointer to the rectangle enclosing the picture at position aPos. If there is no picture at this position, returns NULL. |
| aPictureFrameEdges | On return, indicates whether aPos is located within the active region around a picture edge. The active region is the region inside which the cursor can be used to resize the picture. A value of zero indicates that aPos is not within this region. Otherwise, this value indicates which active region aPos is located in. For more information, see TFrameOverlay::TEdges. |
| IMPORT_C const TRect & | ViewRect | ( | ) | const |
Gets the rectangle in which the text is displayed.
| IMPORT_C const TTmDocPos & | VisualEndOfRunL | ( | const TTmDocPos & | aStart, |
| const TTmDocPos & | aEnd, | |||
| TCursorPosition::TVisualEnd | aDirection | |||
| ) | ||||
Calculates which of two document positions would be considered more left or more right, depending on the value of aDirection.
| Parameters | |
|---|---|
| aStart | First document position to compare. |
| aEnd | Second document position to compare. |
| aDirection | If EVisualLeft, the function returns the left-most of aStart and aEnd. If EVisualRight, the function returns the right-most. |
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.
| Parameters | |
|---|---|
| aPoint | Window coordinates. On return, contains the window coordinates of the nearest character to the point. |