CEikEdwin Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Friends

Data Structures

Specifies the chunk size as either a word, or a paragraph.

Enumerator:

EChunkWord	A word.
EChunkPara	A paragraph.

Defines the possible commands for ClipboardL().

Enumerator:

ENoClipboard	Do nothing.
ECut	Cut.
ECopy	Copy.
EPaste	Paste.

Enumerates the hotkeys that are defined an r_eik_edwin_ctrl_hotkeys or r_eik_edwin_shift_ctrl_hotkeys resource.

Not all are applicable to plain text editors.

Enumerator:

EHotKeyCut	Cut.
EHotKeyCopy	Copy.
EHotKeyPaste	Paste.
EHotKeyUndo	Undo.
EHotKeyFind	Find.
EHotKeyInsertChar	Insert a character.
EHotKeyBold	Bold.
EHotKeyItalic	Italic.
EHotKeyUnderline	Underline.
EHotKeyFont	Font.
EHotKeyInsertObject	Insert an object.
EHotKeyEditObject	Edit an object.
EHotKeyFormatObject	Format an object.

Specifies the chunk size as either a word, or a paragraph.

Enumerator:

ERichText	Rich text editor used.
EDragDouble	For double item dragging.
ELeftDownInViewRect	If set, indicates the pointer being pressed inside the editor rectangle.
ENumericCharacters	Used to calculate initial width.
EHasOneLineOnly	Edwin has one line and is not resizable.
EPhoneNumberGrouping	Custom formatter is installed to find and format phone numbers (CEikRichTextEditor only).
ESuppressNotifyDraw
ESuppressFormatting

Specifies the end points of the editable area.

Enumerator:

EStart	The start of the editable area.
EEnd	The end of the editable area.

The following flags may be ORed together for text searches (see FindL() for example).

Enumerator:

EFindDirectionUp	Search progresses up the screen.
EFindWholeWord	Only whole-word matches count.
EFindCaseSensitive	Search is case-sensitive.
EFindAgain	Finds again.
ENoBusyMessage	Does not display a busy message.
EReadOnlyFile

The following flags may be combined with a bitwise OR to form the aEdwinFlags argument to ConstructL(TInt, .

..) or the flags field of an EDWIN resource structure run through ConstructFromResourceL().

These flags are duplicated in uikon.hrh (see EEikEdwinKeepDocument etc.)

Enumerator:

EZeroEnumValue
EKeepDocument	If set, CEikEdwin does not destroy its content on destruction.
ESegmentedStorage	If set, the content buffer uses segmented storage (see CEditableText::ESegmentedStorage).
EWidthInPixels	The size specified in the resource used to construct the object is given in pixels, not character widths.
ENoAutoSelection	No automatic selection takes place. Normally the entire text is selected whenever the Edwin is created, resized or has its text set as one operation.
EJustAutoCurEnd	If set, then whenever the control is activated the cursor is moved to the end of the text.
ENoWrap	Does not wrap the text being edited.
ELineCursor	Uses a line cursor instead of a block cursor.
ENoHorizScrolling	Does not perform horizontal scrolling.
EInclusiveSizeFixed	If set, scroll bars required to edit long documents appear inside the Edwin. This reduces the area used to display the Edwin. If not set, scroll bars appear outside the Edwin.
EUserSuppliedText	Sets the Edwin’s height according to the number of lines of text supplied by the user.
EOwnsWindow	The Edwin is a window-owning control.
EDisplayOnly	The Edwin does not respond to input at all.
EAlwaysShowSelection	Does not hide the selection if the Edwin loses focus.
EReadOnly	The Edwin is read-only so users cannot add text to any document it displays.
EAllowPictures	If set, no special attempt will be made to delete the embedded pictures cleanly. This flag does not apply to Edwins which do not edit rich text.
EAllowUndo	The Edwin supports undo operations.
ENoLineOrParaBreaks	Does not allow line or paragraph breaks in the text being edited.
EOnlyASCIIChars	Allows only ASCII characters.
EResizable	The Edwin is resizable.
EIgnoreVirtualCursor	The Edwin ignores the virtual cursor.
ENoCustomDraw	No custom draw is done.
EAvkonEditor	Changes layout to Avkon style.
EAvkonDisableCursor	Hides cursor.
EAvkonNotEditable	Changes text editor to non-editable mode.
EEdwinAlternativeWrapping	Sets the Avkon wrapping rules ON.
EAvkonTabsEnabled	Enables tab key handling.

Specifies whether the Edwin owns the document it is being used to edit.

If the Edwin owns the document, the document object is destroyed on destruction.

Enumerator:

EOwnsText	Document is owned by the Edwin.
EDoesNotOwnText	Document is owned by some other object.

When content is supplied to an Edwin using SetDocumentContentL(), this defines whether the new content is added to or has replaced the existing content.

Enumerator:

EUseText	Replaces the Edwin’s existing content.
ECopyText	Copies the supplied content into the existing content.

Destructor.

Deletes objects and frees resources owned by this object. The Edwin’s editable text is freed if the EKeepDocument flag is not set.

C++ default constructor.

Creates a new Edwin, FEP support for the new editor will not be present if there is insufficient memory.

Constructor.

Creates a new Edwin, specifying the border to use. As with the default constructor, FEP support for the new editor will not be present if there is insufficient memory. S60 Edwin does not support / draw any borders.

Parameters:

aBorder

The Edwin border.

From CCoeControl.

Sets the Edwin as ready for drawing.

Leave:

KErrNoMemory.

Reimplemented in CEikGlobalTextEditor, and CEikRichTextEditor.

Adds an observer of standard Edwin events to the list of observers, creating the list if necessary.

May be called any number of times and is independent of calls to SetEdwinObserver.

Parameters:

aEdwinObserver

The observer to add to the list of observers.

Adds user flags.

See TFlags.

Parameters:

aFlag

Flags to add.

Returns the input mode that has been saved to editor state.

Returns:

Input Mode that is saved to editor state.

Gets edwin's flags from CAknEdwinState.

Returns:

The control's flags.

Gets the average number of characters on a line.

Returns:

The average number of characters on a line.

Gets the average number of lines shown in Edwin’s view.

Returns:

The average number of lines.

Completes the second-phase construction of a CEikEdwin object.

This protected function is called by ConstructL() and ConstructFromResourceL() after the Edwin’s size, flags and text limit have been set. Derived classes should call either this function or CEikEdwin’s ConstructL() or ConstructFromResourceL() functions during their construction before initialising their own members.

Reimplemented in CEikGlobalTextEditor.

Recalculates the screen width of an Edwin from the specified number of character widths.

This is called during construction. If the Edwin only allows editing of numbers, the width of the zero character (0) is used; otherwise CFont::MaxNormalCharWidthInPixels() is used.

If the EWidthInPixels flag has been set, the aWidthInChars argument is measured in pixels, not characters.

Parameters:

aWidthInChars

Width in either pixels or characters.

Cancels any current transaction with the Edwin’s front-end processor.

Any front-end input windows are removed, and any highlighted text being edited in the Edwin is removed. The Edwin is rolled back to the state it was in before the FEP transaction started. This function is called by CEikEdwin itself when the document content, the cursor position or the current selection is changed.

Cancelling outstanding FEP transactions before performing operations on the text programmatically is particularly important when the front-end processor is inline-editing an Edwin.

Cancels the insertion of a character format.

This can be used for rich text only.

Cancels the selection and any FEP composition text.

This function then repositions the cursor at the specified end of the currently selected text.

Parameters:

aEndOfSelectionToLeaveCursor

The end of the current selection at which the cursor is repositioned.

Tests whether an undo is possible.

Returns ETrue only if the undo store is available to Edwin.

Returns:

ETrue if the undo store is available. EFalse if the undo store is not available.

Tests whether the selected text can be copied.

Returns:

ETrue if it is possible to copy the selected text.

Implements MEikCcpuEditor.

Tests whether the selected text can be cut.

Returns:

ETrue if it is possible to cut the selected text.

Implements MEikCcpuEditor.

Tests whether text can be pasted from the clipboard.

Returns:

ETrue if it is possible to paste the clipboard text.

Implements MEikCcpuEditor.

Tests is it possible to undo previous operation.

Returns:

ETrue if it is possible to undo previous operation.

Implements MEikCcpuEditor.

Copies selected text.

Implements MEikCcpuEditor.

Cuts selected text.

Implements MEikCcpuEditor.

Tests whether the editor is focused.

Returns:

If editor is focused, ETrue is returned.

Implements MEikCcpuEditor.

Pastes text from the clipboard to the editor.

Implements MEikCcpuEditor.

Undoes the most recent text operation when the Edwin supports this feature and when the undo store is not empty.

Implements MEikCcpuEditor.

Checks that is Edwin's extension created.

If not, it will be created.

Leave:

KErrNoMemory If the Edwin FEP support pointer is NULL.

Determines whether the document being edited is read only.

Displays a message with CEikonEnv::InfoMsg() if the document is set as read-only.

Removes unwanted pictures.

If EAllowPictures has been set, returns immediately. Otherwise, this function checks the document text between two bounds and removes all pictures in that range.

Parameters:

	aStartPos	Where to start looking for unwanted pictures.
	aLength	Where to stop.

Removes all non-ASCII characters from the specified text.

This can be used to remove Unicode characters where they are not valid characters for example.

Parameters:

	aStartPos	The start position in the text.
	aLength	The number of characters, beginning with aStartPos to check.

Removes the selection and any composition text.

The cursor position is unaffected. If there is no selected region, this function has no effect.

Deletes the undo store.

Handles cut, copy and paste commands.

This function also reports a change of state of the control to the observer when necessary.

Parameters:

aClipboardFunc

Clipboard operation.

From CCoeControl.

Completes the construction of a new Edwin. This function initialises the heap-stored members from an EDWIN resource.

Parameters:

aReader

A reader positioned for reading from an EDWIN resource.

Reimplemented in CAknIntegerEdwin, CEikFloatingPointEditor, CEikFixedPointEditor, CEikGlobalTextEditor, and CEikRichTextEditor.

Handles Symbian 2nd phase construction.

Completes construction of a new Edwin, initialising its heap-stored members from the supplied arguments.

Parameters:

	aEdwinFlags	Bitwise ORed combination of flags from TFlags. Default value is 0.
	aWidthInChars	Specifies the width for the Edwin, in characters or pixels: see the EWidthInPixels flag. Default value is 0.
	aTextLimit	Maximum length for the text to present as editable. Default value is 0.
	aNumberOfLines	Height for the Edwin, in lines. Default value is 0.

Replaces the current Edwin text.

Parameters:

	aInText	Text with which the current text is replaced.
	aOutText	On return, the replaced text.

Reimplemented in CEikRichTextEditor.

Copies the highlighted text into a stream store.

Parameters:

[out]	aStore	Store to write to.
[in]	aDict	Stream dictionary.

Counts and returns the number of words in the document.

Returns:

The number of words in the document.

Creates a new CLafEdwinCustomDrawBase instance.

Returns:

Pointer to new custom CLafEdwinCustomDrawBase object.

Creates new text layout.

Parameters:

aLayDoc

Pointer to the MLayDoc implementation that is the source of the text and formatting information.

Creates a pre-allocated scroll bar frame.

Returns:

Pre-allocated scroll bar frame.

Creates the Edwin scroll bar frame with no pre-allocation of memory for scroll bars.

Returns:

The scroll bar frame.

Creates new instance of CGlobalText and text layout based on it.

Parameters:

	aParaFormatLayer	Paragraph format layer pointer for CGlobalText constructor.
	aCharFormatLayer	Character format layer pointer for CGlobalText constructor.

Allocates memory for the Edwin text view.

Gets the cursor’s position within the document.

Returns:

The cursor’s position within the document.

Deletes the text under the cursor selection, also cancelling the selection.

This function asks the user to confirm this action if aPromptConfirmation is ETrue.

Parameters:

[out]	aChanged	On return, ETrue if the text was changed.
[in]	aIsBackSpace	ETrue if this is in response to backspace being pressed. Determines whether character formatting is preserved or not. Default value is EFalse.
[in]	aPromptConfirmation	Optional. ETrue to ask the user to confirm this action. Default value is ETrue.

Returns:

The cursor position in the text after deletion.

Deletes the cursor’s selection.

If no selection is made, this function deletes only one character. The argument aIsBackSpace determines whether to preserve the character formatting or not.

Parameters:

[out]	aChanged	On return, ETrue if the text was changed.
[in]	aSelection	The cursor selection describing the position to be deleted.
[in]	aIsBackSpace	ETrue if this in response to backspace being pressed. Determines whether character formatting is preserved or not.
[in]	aAllowUndo	ETrue if the user is permitted to undo this change.

Displays an information message to indicate that the specified text could not be found.

The information message is constructed from R_EIK_TBUF_CANNOT_FIND_TEXT.

Parameters:

aFindText

The text that could not be found.

From CCoeControl.

Draws the control on request.

Parameters:

aRect

If supplied, the rectangle in which to draw the Edwin.

Reimplemented from CEikBorderedControl.

Draws the visible text and the cursor.

Redraws text view.

Used for pictograph animations.

From MEditObserver.

Observer function called by the CRichText object when the object is edited to give notification of changes to its text buffer. In this way, the control knows how the text object has changed and can reformat and redraw the text object appropriately.

Parameters:

	aStartEdit	The start position of the edit.
	aEditLength	The number of characters added or, if negative, deleted after this position.

Reimplemented in CEikRichTextEditor.

Called to determine the background color to draw.

It is not to be used if skinning is being used to draw the background.

This API can be used two ways:

i) If the caller has a default color to offer (to be used as a fallback if SetBackgroundColorL has not been called), then he should use the Input/Output parameter aConditionalColor, and ignore the return value. The output parameter will only be over-written by the set background color if SetBackgroundColorL has been called.

ii) If the caller does not have a default color to offer, then he should pass in a dummy input parameter and use the return value.

Parameters:

aConditionalColor

Output parameter. Returns a color set by SetBackgroundColorL. It is unchanged if background color has not been set by SetBackgroundColorL

Returns:

TRgb for the color to be used for background.

Gets the editor state.

Returns:

Pointer to editor state object.

Gets Edwin's extension.

Returns:

Pointer to Edwin's extension.

Enables or disables CCPU interface provided functionalities (cut, copy, paste and undo).

Parameters:

aSupport

CCPU support enabled if ETrue.

Gets true if a substring is present in the text being edited before or after the cursor position.

If aFindText is NULL, then the current word or selection will be searched for again.

Parameters:

	aFindText	The substring to search for.
	aFindFlags	See TFindFlags. Default value is 0.

Returns:

ETrue if aFindText is found.

Gets the cursor position of the matching text in the document.

The search starts from aPos. If aFindText is NULL, then the current word or selection will be searched for. If the substring cannot be found, this function returns KErrNotFound.

Parameters:

	aFindText	The substring to search for.
	aPos	Starting position for the find.
	aFindFlags	See TFindFlags.

Returns:

KErrNotFound if the text was not found, otherwise the position of the matched substring.

From CCoeControl.

Responds to focus-changed events.

Parameters:

aDrawNow

Not used.

Forces the scrollbars to update now; this is a synchronous function.

Formats all the text in the text view.

Called by several functions, for example by CEikEdwin::HandleTextChangedL() and CEikEdwin::SetTextL().

From CCoeControl.

Gets the list of logical colours employed in the drawing of the control, paired with an explanation of how they are used. Appends the list to aColorUseList.

Parameters:

[out]

aColorUseList

The list of logical colours.

Reimplemented from CEikBorderedControl.

Gets the current word or selection and searches for it.

This function is called by FindL() and FindTextL() when no text to search for is given.

Parameters:

aFindText

An empty descriptor.

Copies the entire document’s content into a descriptor.

It is the caller's responsibility to provide a large enough buffer.

Parameters:

[out]

aDes

An initialised descriptor which on return contains a copy of the content of this Edwin.

Gets a new buffer containing a copy of the whole text document.

Returns:

A new copy of the document text.

Gets the rectangle set for drawing only full lines.

In case the feature is disabled, this returns an empty rect. This is intended for internal use.

Returns:

The rect which contains text lines to be drawn

Gets the start position and the length of the word in which the specified document position is located.

Parameters:

[in]	aCurrentPos	A position within a word in the text.
[out]	aStartPos	Returns the start position of the word.
[out]	aLength	Returns the word’s length.

From CCoeControl.

Handles pointer events.

Parameters:

aPointerEvent

Pointer event to respond to.

Reimplemented from CEikBorderedControl.

Reimplemented in CAknNumericEdwin, CAknIntegerEdwin, CEikFloatingPointEditor, CEikFixedPointEditor, CEikGlobalTextEditor, and CEikRichTextEditor.

From CCoeControl.

Handles a change to Edwin’s resources which are shared across the environment. Colours or fonts for example.

Parameters:

aType

The type of resource that was changed.

Reimplemented from CEikBorderedControl.

Reimplemented in CAknIntegerEdwin, CEikFloatingPointEditor, and CEikFixedPointEditor.

From MEikScrollBarObserver.

Handles scrollbar key events.

Parameters:

	aScrollBar	The scrollbar.
	aEventType	The type of key event.

Implements MEikScrollBarObserver.

Handles a change in Edwin’s size.

This function accounts for text wrap settings and whether the Edwin is ready to be redrawn and also calls functions to reformat text and to update the Edwin’s scroll bars.

Handles all modifications made by reformatting the entire document.

Calls CEikEdwin::FormatText() and redraws Edwin contents and scroll bars if they are ready to be redrawn.

Not implemented.

Parameters:

	aStartPos	Not used.
	aLength	Not used.

Gets highlight style.

Returns:

The highlight style.

Uses SetScrollBarsL() to set the scrollbars.

Parameters:

aPtr

Pointer to CEikEdwin instance.

Returns:

Integer value of EFalse.

From CCoeControl.

Access to the input capabilities of the edwin.

If this function is overrided in a subclass, the subclass should obtain this class' InputCapabilities' object provider through TCoeInputCapabilities::ObjectProvider() and set that as a part of the subclass' InputCapabilities object provider chain to ensure maximum functionality.

Returns:

The Edwin input capabilities.

Reimplemented in CEikFloatingPointEditor, and CEikFixedPointEditor.

Replaces the cursor selection with the identified text.

Parameters:

	aInsertPos	The position at which text will be inserted.
	aText	The text to insert.
	aDelete	The cursor-selected text that will be replaced by aText.

Inserts a field at the current cursor position.

If a selection was made the field replaces that selection.

Parameters:

	aField	Text field to insert.
	aFieldType	Type of the field.

Inserts the contents of a text file into the text being edited at the current cursor position.

Parameters:

	aFileName	The file to open and read.
	aTextOrganisation	How to handle line breaks. Default value is CPlainText::EOrganiseByLine.

Tests if the background drawing is suppressed.

Returns:

ETrue if the background drawing is suppressed

Determines whether the document being edited with Edwin is read-only.

Returns:

ETrue if the document being edited is read-only. EFalse otherwise.

Gets the width used for laying out the text inside the Edwin in pixels.

This may be larger or smaller than the width of the Edwin itself. See SetWysiwygModeOn() for example.

Returns:

Width of the text layout area in pixels.

Gets the width of a line cursor in pixels.

Returns:

Always 0.

Reimplemented in CEikGlobalTextEditor.

Gets the lower limit for formatting.

This returns the value of KPartialFormattingLowerThreshold which determines when a switch is made from formatting only visible text to formatting all text. When the text length exceeds the KFullFormattingUpperThreshold only visible text is formatted. If some characters are deleted so that the text length is less than KFullFormattingUpperThreshold the entire text is still not formatted. Instead, reformatting occurs only when the number of characters is less than the value of KPartialFormattingLowerThreshold.

Returns:

The value of KPartialFormattingLowerThreshold.

Gets the text view margins.

Returns:

The text view margins.

Gets the maximum Edwin height.

Please do not use the following method for deciding heights if you are using edwins with Maximum Heights in forms. Use MaximumHeightInLines instead.

Returns:

The maximum Edwin height.

Gets editor maximum height in lines.

Returns:

Maximum height in lines.

Gets the editor maximum length.

Returns:

The editor maximum length

Gets the minimum Edwin height.

Returns:

The minimum Edwin height.

From CCoeControl.

Gets the minimum size of this Edwin for automatic-layout control contexts such as dialogs.

Returns:

Minimum size for the control.

From MObjectProvider.

Retrieves an object of the same type as that encapsulated in aId.

This function is used to allow controls to ask their owners for access to other objects that they own.

Other than in the case where NULL is returned, the object returned must be of the same object type - that is, the ETypeId member of the object pointed to by the pointer returned by this function must be equal to the iUid member of aId.

Parameters:

aId

An encapsulated object type ID.

Returns:

Encapsulates the pointer to the object provided. Note that the encapsulated pointer may be NULL.

Sets the new cursor position.

If the cursor is no longer visible the document is scrolled to display the line containing the new cursor position. Scrollbars are also updated if present.

Parameters:

	aMovement	The cursor movement.
	aSelect	If ETrue, the selection is extended. This corresponds to holding down the Shift key on a machine keyboard.

Moves the cursor to the beginning of the next word or paragraph.

This function cancels any front end processing transaction currently in progress for the Edwin.

Parameters:

	aSelect	If ETrue the chunk is selected, otherwise EFalse.
	aChunkSize	The chunk size, this can be either a word or a paragraph. See TChunkSize enum.
	aEndScanningTowards	Which direction to scan towards, the start or the end of the document.

Scrolls the text either horizontally or vertically without affecting the cursor’s position.

Parameters:

aMovement

The cursor's movement.

Sets non-printing characters’ visibility.

Returns:

Non-printing characters’ visibility.

This call causes FEP to reset current editing state and new editing state is fetched from CAknEdwinState object.

Formats and draws a new document, updates scrollbars if necessary.

Reformats and redraws the document, updates scrollbars if necessary.

From CCoeControl.

Handles key events.

Parameters:

	aKeyEvent	The key event.
	aType	The type of the event: EEventKeyDown, EEventKeyUp or EEventKey.

Returns:

A suitable response code.

Reimplemented in CAknIntegerEdwin, CEikFloatingPointEditor, CEikFixedPointEditor, CEikGlobalTextEditor, and CEikRichTextEditor.

Confirms whether the deletion of the user’s selection is required.

If the user’s selection is less than KBlockDeleteWarningSize and does not contain a picture, this function returns ETrue.

If the user’s selection is greater than KBlockDeleteWarningSize or contains a picture, this function asks the user to confirm deletion of their selection and then returns the user’s response.

Returns:

ETrue.

Tests whether the EOnlyASCIIChars flag is set.

Returns:

ETrue if the EOnlyASCIIChars flag is set.

From CTextView::MObserver.

Called after reformatting but before redisplay so that edit windows etc. can be resized.

Parameters:

aTextView

Not used.

Copies the contents of a stream store to the current cursor position, replacing any selected text.

This function is used to paste data from the clipboard.

Parameters:

[out]	aStore	Store from which to read.
[in]	aDict	Stream dictionary.

Returns pictograph animation callback.

If it is not set, the function pointer is NULL.

Returns:

Pictograph animation callback

Copies the contents of the cursor selection onto the clipboard.

Used in ConstructFromResourceL().

Sets Avkon editor properties.

Parameters:

aReader

A reader positioned for reading from an EDWIN resource.

Receives an Edwin document using an infra red beamer.

This function will leave if the data received is not a suitable type to be pasted into the Edwin.

Removes the specified observer from the list of observers.

Does nothing if aEdwinObserver is not an observer.

Parameters:

aEdwinObserver

The observer to remove from the list of observers.

Removes user flags.

See TFlags.

Parameters:

aFlag

Flags to remove.

Replaces all occurrences of a string with new text.

Both old and new text are held in aFindModel.

Parameters:

[in,out]

aFindModel

Pointer to the replacement text.

Leave:

This function will leave if the replace operation fails unexpectedly.

Replaces the highlighted text.

See SEdwinFindModel struct.

Parameters:

[in,out]

aFindModel

Pointer to the replacement text.

Reports an Edwin event of the specified type.

The Edwin event is passed first to the Edwin observer and then to the list of observers, even if the first Edwin observer is not set. If the Edwin has a custom drawer, and the event is of type EEventFormatChanged, the event is passed to the custom drawer. If the Edwin has an observer the event is passed to that observer. If no observer is set for the Edwin, this function passes the event to each observer in the observer list.

Parameters:

aEventType

The type of event to report.

Displays a dialog allowing the user to choose a character from the character map.

The selected character is inserted into the Edwin at the current cursor position.

Gets the scroll bar frame surrounding this Edwin.

Returns:

Pointer to this Edwin’s scroll bar frame.

Selects the entire document.

Gets the cursor selection.

If no text view is associated to the Edwin this returns TCursorSelection(0,0).

Returns:

The current selection.

Gets the number of characters including non-printing characters within the selection.

Returns:

The number of characters within the selection.

Sends the Edwin’s document using an infra red beamer.

Sets allowed input modes for the editor.

All input modes are allowed (EAknEditorAllInputModes) if the value is not set from EDWIN resource allowed_input_modes or with this API.

Parameters:

aInputModes

Input modes that are allowed in the editor.

Sets default case for the editor.

The case is used when the editor is focused first time. Available case flags from uikon.hrh are EAknEditorUpperCase, EAknEditorLowerCase and EAknEditorTextCase. EAknEditorTextCase is used if the initial case is not set from EDWIN resource default_case or with this API.

Parameters:

aCase

Initial case to be used in the editor.

Updates editor case.

FEP is automatically notified of the case change in editor state and FEP takes new case to use immediately. Available case flags from uikon.hrh are EAknEditorUpperCase, EAknEditorLowerCase and EAknEditorTextCase. This method should not be used to set initial case for the editor. Use SetAknEditorCase() method instead for setting initial case.

Parameters:

aCase

New case for the editor.

Updates editor input mode.

FEP is automatically notified of the new input mode in editor state and FEP takes new input mode to use immediatelly. Current inline editing is reset. This method should not be used for setting initial input mode for the editor. Use SetAknEditorInputMode() method instead for setting initial input mode.

Parameters:

aInputMode

New input mode for the editor.

Sets initial editor flags for the editor.

This method can be used also to update editor flags after the editor is focused. FEP is automatically notified of the updated editor flags.

Parameters:

aFlags

Avkon editor flags for the editor.

Sets default input mode for the editor.

The input mode is used when the editor is focused first time. EAknEditorTextInputMode is used if the initial input mode is not set from EDWIN resource default_input_mode or with this API.

Parameters:

aInputMode

Initial input mode to be used in the editor.

Sets new local input language for the editor.

Global input language changes have not effect for the input language but the user can still change the input language from the edit menu.

Parameters:

aLanguage

Editor local input language.

Sets number mode key mapping for '*' and '#' keys.

The key mapping is used in editors when numeric input mode is used. Key mapping characters for '*' key are shown on special character table if also text input modes are allowed in the editor but the current input mode is numeric mode. EAknEditorStandardNumberModeKeymap is used in editors that allow only numeric input if the mapping is not set from EDWIN resource numeric_keymap or with this API. EAknEditorAlphanumericNumberModeKeymap is used as default if the editor allows also text input mode.

Parameters:

aNumericKeymap

Key mapping used in an editor with number input mode.

Sets permitted cases for the editor.

Possible flags from uikon.hrh are EAknEditorAllCaseModes, EAknEditorUpperCase, EAknEditorLowerCase and EAknEditorTextCase. EAknEditorAllCaseModes is used if the value is not set from EDWIN resource allowed_case_modes or with this API.

Parameters:

aPermittedCaseModes

Case modes that are available in the editor.

Sets editor specific special character table.

Parameters:

aSCTResId

Special character table dialog resource.

Stores the alignment value for an editor.

Parameters:

aAlignment

Editor alignment to be stored - must be supplied as one of the values in Avkon editor alignment enum i.e.: EAknEditorAlignCenter, EAknEditorAlignLeft, EAknEditorAlignRight, EAknEditorAlignBidi

Sets whether the document accepts pictures.

Parameters:

aAllow

ETrue sets the document to accept pictures, EFalse sets the document to not accept pictures.

Sets whether the undo operation is permitted.

Parameters:

aAllow

ETrue to permit undo operations. EFalse to not permit undo operations.

Controls the formatting mode of the editor.

The length of the text is compared against the current formatting mode thresholds. (See method SetUpperFullFormattingLength). If the length is greater than the upper limit of full formatting, then the editor is set to "band" formatting, where the editor attempts to format as little as is needed, e.g. the visible part of the editor. If the text length is less than the lower limit of band formatting, then the formatting mode is switched to full document formatting.

This method has a flag to allow any immediate re-formatting to be suppressed. Formatting text can be a time-consuming operation. If the client is able to ensure that no reformatting is needed, (for instance if a further re-formatting API is going to be called later) then the reformatting flag can be called with EFalse. Otherwise, a re-format will take place within this method.

Parameters:

	aIsNewDoc	If EFalse, attempts to perform re-formatting based upon current formatting If not EFalse, whole document it formatted from scratch Note: This parameter is ignored if aReFormat is EFalse
	aReFormat	If EFalse, do not perform any re-formatting

Controls the formatting mode of the editor.

The length of the text is compared against current formatting mode thresholds. (See method SetUpperFullFormattingLength). If the length is greater than the upper limit of full formatting, then the editor is set to "band" formatting, where the editor attempts to format as little as is needed, e.g. the visible part of the editor. If the text length is less than the lower limit of band formatting, then the formatting mode is switched to full document formatting.

This method performs an immediate re-formatting of all or part of the text with the new formatting mode.

Parameters:

aIsNewDoc

If EFalse, attempts to perform re-formatting based upon current formatting If not EFalse, whole document it formatted from scratch Note: This parameter is ignored if aReFormat is EFalse

Sets the average number of characters per line.

Parameters:

aAvgChars

The average number of characters per line.

Sets the average number of lines displayed in Edwin’s view.

Parameters:

aAvgLines

The average number of lines to display.

Sets the EAvkonEditor flag.

Parameters:

aAvkonWrapIsOn

If ETrue EAvkonEditor flag is set.

Sets the Edwin’s background colour.

Parameters:

aBackground

New value for the background colour.

Sets the text view margins.

Parameters:

aMargins

New value for the view’s margins.

Sets the character format layer for the editor.

Parameters:

aCharFormatLayer

Pointer to the character format layer object.

From CCoeControl.

Sets the containing window for the Edwin by copying it from the specified parent. Also copies a control context from aParent if one has not been previously set.

Parameters:

aParent

The control to set as this Edwin’s parent.

Creates the containing window for the Edwin if it does not already have one.

Sets the cursor’s position within the document.

If the new position is not visible the text is scrolled so that the line containing the cursor is visible. This function also updates the scroll bar thumbs if present.

Parameters:

	aCursorPos	New cursor position.
	aSelect	ETrue to extend the cursor’s selection to the new position. EFalse otherwise.

From CCoeControl.

Dims or undims the Edwin.

Parameters:

aDimmed

ETrue to dim the Edwin. EFalse to undim the Edwin.

Sets the Edwin’s editable content.

Before calling this function you must get the iText pointer as iText is replaced by aText. You must also free the memory by deleting the previous iText contents.

Parameters:

	aText	New value for the content.
	aContent	Specifies whether to use aText itself, or to copy its content. Default value is CEikEdwin::ECopyText.

Sets whether the Edwin owns a document.

Edwins can either be used as a standalone text editor control, or as an editor for text owned by another object. The document ownership setting determines whether the Edwin or another object owns the document.

Parameters:

aOwner

Whether Edwin or another object owns the document. See TOwnershipType.

Sets the Edwin observer.

The Edwin’s observer will be called back with control events associated with the Edwin.

Parameters:

aEdwinObserver

New observer.

Sets the Edwin size observer.

Does not imply transfer of ownership.

Parameters:

aEdwinSizeObserver

The Edwin size observer.

Sets highlight style.

Parameters:

aStyle

The highlight style.

From CCoeControl.

This method sets the input capabilities of the edwin. Ownership of the T-class is not transferred.

Parameters:

aInputCapabilities

Reference to an input capabilities object on the heap.

Leave:

KErrNoMemory Edwin FEB support object is not created.

Sets margin widths and line cursor width.

Sets the maximum Edwin height.

This function also decreases the minimum Edwin height if its value is greater than aHeight.

Please do not use the following method for setting maximum heights if you are using edwins with maximum heights in forms. Use MaximumHeightInLines instead.

Parameters:

aHeight

The maximum Edwin height.

Sets editor's maximum height in lines.

Parameters:

aLines

Maximum height in lines.

Sets maximum length for the editor.

Parameters:

aLength

Maximum length for the editor.

Sets the minimum Edwin height.

This function also increases the maximum Edwin height if its value is less than aHeight.

Sets non-printing characters’ visibility.

Parameters:

aVisibility

Non-printing characters’ visibility.

Sets the EOnlyASCIIChars flag.

Parameters:

aASCIIOnly

If ETrue the EOnlyASCIIChars flag will be set. If EFalse the EOnlyASCIIChars flag will be removed.

Sets the paragraph format layer for the editor.

Parameters:

aParaFormatLayer

Pointer to the paragraph format layer object.

Sets the EPasteFromIrStore flag.

Parameters:

aPasteFromIrStore

ETrue to set the EPasteFromIrStore flag. EFalse to remove the EPasteFromIrStore flag.

Sets the callback, which the editor calls after having redrawn itself for animated pictographs.

CEikCaptionedControl uses it to draw the highlight frame on top of the editor.

Parameters:

aCallBack

The callback.

Sets the Edwin’s read-only flag so that documents displayed by Edwin cannot be edited by users.

Parameters:

aReadOnly

ETrue to set Edwin to display documents as read-only. EFalse otherwise.

Sets the minimum gap between text and the right hand edge of the Edwin when text is wrapped.

This value is used to calculate the layout area for text.

Parameters:

aGap

Size of the gutter in pixels.