CEikEdwin Class Reference

API published in: S60 1st Ed

Link against: avkon.lib eikctl.lib eikcoctl.lib uiklaf.lib form.lib

Capability Information

Required Capabilities

None


#include <eikedwin.h>

Inherits CEikBorderedControl, MEikScrollBarObserver, and MEikCcpuEditor.

Inherited by CAknNumericEdwin, and CEikGlobalTextEditor.


Detailed Description

Base class for controls that display and allow manipulation of text.

The properties of a particular Edwin object can be set using bitwise flags, which are defined in member enums (see TFlags for example).

Edwins support Front End Processors, and so are a highly effective way of getting textual data from the user. The text currently being composed by the user is called the composition text.


Public Types

enum   TFlags {
  EZeroEnumValue = 0x00000000, EKeepDocument = 0x00000001, ESegmentedStorage = 0x00000002, EWidthInPixels = 0x00000004,
  ENoAutoSelection = 0x00000008, EJustAutoCurEnd = 0x00000010, ENoWrap = 0x00000020, ELineCursor = 0x00000040,
  ENoHorizScrolling = 0x00000080, EInclusiveSizeFixed = 0x00000100, EUserSuppliedText = 0x00000200, EOwnsWindow = 0x00000400,
  EDisplayOnly = 0x00000800, EAlwaysShowSelection = 0x00001000, EReadOnly = 0x00002000, EAllowPictures = 0x00004000,
  EAllowUndo = 0x00008000, ENoLineOrParaBreaks = 0x00010000, EOnlyASCIIChars = 0x00020000, EResizable = 0x00040000,
  EIgnoreVirtualCursor = 0x00080000, ENoCustomDraw = 0x01000000, EAvkonEditor = 0x02000000, EAvkonDisableCursor = 0x04000000,
  EAvkonNotEditable = 0x08000000, EEdwinAlternativeWrapping = 0x10000000, EAvkonTabsEnabled = 0x20000000
}
  The following flags may be combined with a bitwise OR to form the aEdwinFlags argument to ConstructL(TInt, . More...
enum   TClipboardFunc { ENoClipboard, ECut, ECopy, EPaste }
  Defines the possible commands for ClipboardL(). More...
enum   TFindFlags {
  EFindDirectionUp = 0x01, EFindWholeWord = 0x02, EFindCaseSensitive = 0x04, EFindAgain = 0x08,
  ENoBusyMessage = 0x10, EReadOnlyFile = 0x20
}
  The following flags may be ORed together for text searches (see FindL() for example). More...
enum   TSetContent { EUseText, ECopyText }
  When content is supplied to an Edwin using SetDocumentContentL(), this defines whether the new content is added to or has replaced the existing content. More...
enum   TOwnershipType { EOwnsText, EDoesNotOwnText }
  Specifies whether the Edwin owns the document it is being used to edit. More...
enum   TEdwinHotKeys {
  EHotKeyCut, EHotKeyCopy, EHotKeyPaste, EHotKeyUndo,
  EHotKeyFind, EHotKeyInsertChar, EHotKeyBold, EHotKeyItalic,
  EHotKeyUnderline, EHotKeyFont, EHotKeyInsertObject, EHotKeyEditObject,
  EHotKeyFormatObject
}
  Enumerates the hotkeys that are defined an r_eik_edwin_ctrl_hotkeys or r_eik_edwin_shift_ctrl_hotkeys resource. More...

Public Member Functions

IMPORT_C  ~CEikEdwin ()
  Destructor.
IMPORT_C  CEikEdwin ()
  C++ default constructor.
IMPORT_C  CEikEdwin (const TGulBorder &aBorder)
  Constructor.
IMPORT_C void  ConstructL (TInt aEdwinFlags=0, TInt aWidthInChars=0, TInt aTextLimit=0, TInt aNumberOfLines=0)
  Handles Symbian 2nd phase construction.
IMPORT_C void  SetEdwinObserver (MEikEdwinObserver *aEdwinObserver)
  Sets the Edwin observer.
IMPORT_C void  AddEdwinObserverL (MEikEdwinObserver *aEdwinObserver)
  Adds an observer of standard Edwin events to the list of observers, creating the list if necessary.
IMPORT_C void  RemoveEdwinObserver (MEikEdwinObserver *aEdwinObserver)
  Removes the specified observer from the list of observers.
IMPORT_C void  SetContainerWindowL ()
  Creates the containing window for the Edwin if it does not already have one.
IMPORT_C void  SetDocumentContentL (CGlobalText &aText, TSetContent aContent=CEikEdwin::ECopyText)
  Sets the Edwin’s editable content.
IMPORT_C TKeyResponse  OfferKeyEventL (const TKeyEvent &aKeyEvent, TEventCode aType)
  From CCoeControl.
IMPORT_C void  FocusChanged (TDrawNow aDrawNow)
  From CCoeControl.
IMPORT_C void  ActivateL ()
  From CCoeControl.
IMPORT_C void  ConstructFromResourceL (TResourceReader &aReader)
  From CCoeControl.
IMPORT_C void  HandlePointerEventL (const TPointerEvent &aPointerEvent)
  From CCoeControl.
IMPORT_C TSize  MinimumSize ()
  From CCoeControl.
IMPORT_C void  Draw (const TRect &aRect) const
  From CCoeControl.
IMPORT_C void  SetDimmed (TBool aDimmed)
  From CCoeControl.
IMPORT_C void  SetContainerWindowL (const CCoeControl &aParent)
  From CCoeControl.
virtual IMPORT_C void  GetColorUseListL (CArrayFix< TCoeColorUse > &aColorUseList) const
  From CCoeControl.
virtual IMPORT_C void  HandleResourceChange (TInt aType)
  From CCoeControl.
IMPORT_C TCoeInputCapabilities  InputCapabilities () const
  From CCoeControl.
IMPORT_C void  SetInputCapabilitiesL (const TCoeInputCapabilities &aInputCapabilities)
  From CCoeControl.
IMPORT_C void  WriteInternalStateL (RWriteStream &aWriteStream) const
  From CCoeControl.
IMPORT_C void  HandleScrollEventL (CEikScrollBar *aScrollBar, TEikScrollEvent aEventType)
  From MEikScrollBarObserver.
IMPORT_C void  OnReformatL (const CTextView *aTextView)
  From CTextView::MObserver.
IMPORT_C TInt  TextLength () const
  Gets the number of characters in the document.
IMPORT_C TInt  CursorPos () const
  Gets the cursor’s position within the document.
IMPORT_C TInt  SelectionLength () const
  Gets the number of characters including non-printing characters within the selection.
IMPORT_C TCursorSelection  Selection () const
  Gets the cursor selection.
IMPORT_C void  ClearSelectionL ()
  Removes the selection and any composition text.
IMPORT_C void  SetSelectionL (TInt aCursorPos, TInt aAnchorPos)
  Sets the text selection.
IMPORT_C void  SetCursorPosL (TInt aCursorPos, TBool aSelect)
  Sets the cursor’s position within the document.
IMPORT_C void  SelectAllL ()
  Selects the entire document.
IMPORT_C void  CalculateWidth (TInt aWidthInChars)
  Recalculates the screen width of an Edwin from the specified number of character widths.
IMPORT_C void  GetText (TDes &aDes) const
  Copies the entire document’s content into a descriptor.
IMPORT_C HBufC *  GetTextInHBufL () const
  Gets a new buffer containing a copy of the whole text document.
IMPORT_C void  SetTextL (const TDesC *aDes)
  Sets the document text of this Edwin from the contents of a descriptor.
IMPORT_C void  ClipboardL (TClipboardFunc aClipboardFunc)
  Handles cut, copy and paste commands.
IMPORT_C void  InsertFieldL (CTextField *aField, TUid aFieldType)
  Inserts a field at the current cursor position.
IMPORT_C void  UpdateAllFieldsL ()
  Updates all the fields in the document.
IMPORT_C void  UpdateCurrentFieldL ()
  Updates any text field at the current cursor position.
IMPORT_C TInt  CountWords ()
  Counts and returns the number of words in the document.
IMPORT_C void  InsertFromTextFileL (const TFileName &aFileName, const CPlainText::TTextOrganisation aTextOrganisation=CPlainText::EOrganiseByLine)
  Inserts the contents of a text file into the text being edited at the current cursor position.
IMPORT_C CPlainText *  Text () const
  Gets a pointer to the Edwin’s document contents.
IMPORT_C void  CancelFepTransaction ()
  Cancels any current transaction with the Edwin’s front-end processor.
IMPORT_C void  HandleTextChangedL ()
  Handles all modifications made by reformatting the entire document.
IMPORT_C TInt  LayoutWidth () const
  Gets the width used for laying out the text inside the Edwin in pixels.
IMPORT_C void  NotifyNewDocumentL ()
  Formats and draws a new document, updates scrollbars if necessary.
IMPORT_C void  NotifyNewFormatL ()
  Reformats and redraws the document, updates scrollbars if necessary.
IMPORT_C TBool  FindL (const TDesC *aFindText, TInt aFindFlags=0)
  Gets true if a substring is present in the text being edited before or after the cursor position.
IMPORT_C TInt  FindTextL (const TDesC *aFindText, TInt aPos, TInt aFindFlags)
  Gets the cursor position of the matching text in the document.
IMPORT_C void  ReplaceL (SEdwinFindModel *aFindModel)
  Replaces the highlighted text.
IMPORT_C void  ReplaceAllL (SEdwinFindModel *aFindModel)
  Replaces all occurrences of a string with new text.
IMPORT_C void  GetFindText (TDes *aFindText)
  Gets the current word or selection and searches for it.
IMPORT_C void  UpdateScrollBarsL ()
  Updates scrollbars.
IMPORT_C CEikScrollBarFrame CreateScrollBarFrameL ()
  Creates the Edwin scroll bar frame with no pre-allocation of memory for scroll bars.
CEikScrollBarFrame CreatePreAllocatedScrollBarFrameL ()
  Creates a pre-allocated scroll bar frame.
CEikScrollBarFrame ScrollBarFrame ()
  Gets the scroll bar frame surrounding this Edwin.
IMPORT_C void  SetWordWrapL (TBool aWrapIsOn)
  Sets word wrapping on or off.
virtual IMPORT_C TInt  LineCursorWidth () const
  Gets the width of a line cursor in pixels.
IMPORT_C void  SetZoomFactorL (TZoomFactor *aZoomFactor)
  Sets the zoom factor of the document and reformats the document.
IMPORT_C void  SetBackgroundColorL (TRgb aBackground)
  Sets the Edwin’s background colour.
IMPORT_C void  SetWysiwygModeOn (TInt aLayoutWidth, MGraphicsDeviceMap *aDevice)
  Sets the format mode to be WYSIWYG.
IMPORT_C void  SetWysiwygModeOff ()
  Switches off the WYSIWYG mode.
IMPORT_C void  UpdateLayoutWidth (TInt aLayoutWidth)
  Updates the text wrap width.
IMPORT_C void  SendDataOverIrL ()
  Sends the Edwin’s document using an infra red beamer.
IMPORT_C void  ReceiveDataOverIrL ()
  Receives an Edwin document using an infra red beamer.
IMPORT_C void  SetAmountToFormatL (TBool aIsNewDoc=EFalse)
  Controls the formatting mode of the editor.
IMPORT_C void  SetAmountToFormatL (TBool aIsNewDoc, TBool aReFormat)
  Controls the formatting mode of the editor.
IMPORT_C void  SetPasteFromIrStore (TBool aPasteFromIrStore)
  Sets the EPasteFromIrStore flag.
IMPORT_C void  PasteFromStoreL (CStreamStore &aStore, CStreamDictionary &aDict)
  Copies the contents of a stream store to the current cursor position, replacing any selected text.
IMPORT_C void  CopyToStoreL (CStreamStore &aStore, CStreamDictionary &aDict)
  Copies the highlighted text into a stream store.
IMPORT_C void  SetBorderViewMargins (TMargins8 aMargins)
  Sets the text view margins.
IMPORT_C void  ForceScrollBarUpdateL ()
  Forces the scrollbars to update now; this is a synchronous function.
IMPORT_C void  SetDocumentOwnership (TOwnershipType aOwner)
  Sets whether the Edwin owns a document.
IMPORT_C void  SetTextLimit (TInt aLimit)
  Sets the maximum number of characters that can be inserted.
IMPORT_C void  RunCharMapDialogL ()
  Displays a dialog allowing the user to choose a character from the character map.
IMPORT_C TMargins8  Margins () const
  Gets the text view margins.
IMPORT_C TInt  UpperFullFormattingLength () const
  Gets the upper limit for formatting.
IMPORT_C TInt  LowerPartialFormattingLength () const
  Gets the lower limit for formatting.
IMPORT_C void  SetReadOnly (TBool aReadOnly)
  Sets the Edwin’s read-only flag so that documents displayed by Edwin cannot be edited by users.
IMPORT_C TBool  IsReadOnly () const
  Determines whether the document being edited with Edwin is read-only.
IMPORT_C void  CheckNotReadOnlyL ()
  Determines whether the document being edited is read only.
IMPORT_C void  SetAllowPictures (TBool aAllow)
  Sets whether the document accepts pictures.
IMPORT_C void  CheckRemovePictures (TInt aStartPos, TInt aLength)
  Removes unwanted pictures.
IMPORT_C void  SetRightWrapGutter (TInt aGap)
  Sets the minimum gap between text and the right hand edge of the Edwin when text is wrapped.
IMPORT_C void  UndoL ()
  Undoes the most recent text operation when the Edwin supports this feature and when the undo store is not empty.
IMPORT_C void  ClearUndo ()
  Deletes the undo store.
IMPORT_C void  SetAllowUndo (TBool aAllow)
  Sets whether the undo operation is permitted.
IMPORT_C TBool  SupportsUndo () const
  Gets whether Edwin is set to support the undo command.
IMPORT_C TBool  CanUndo () const
  Tests whether an undo is possible.
IMPORT_C void  SetWordDelimiters (TBool aPicture, TBool aPunctuation)
  Sets whether picture characters and/or punctuation should be treated as word delimiters in addition to whitespace.
IMPORT_C void  GetWordInfo (TInt aCurrentPos, TInt &aStartPos, TInt &aLength) const
  Gets the start position and the length of the word in which the specified document position is located.
IMPORT_C void  MoveCursorL (TCursorPosition::TMovementType aMovement, TBool aSelect)
  Sets the new cursor position.
IMPORT_C void  MoveDisplayL (TCursorPosition::TMovementType aMovement)
  Scrolls the text either horizontally or vertically without affecting the cursor’s position.
IMPORT_C void  CheckValidityOfChars (TInt aStartPos, TInt aLength)
  Removes all non-ASCII characters from the specified text.
IMPORT_C void  SetOnlyASCIIChars (TBool aASCIIOnly)
  Sets the EOnlyASCIIChars flag.
IMPORT_C TBool  OnlyASCIIChars () const
  Tests whether the EOnlyASCIIChars flag is set.
TInt  AvgLinesInViewRect () const
  Gets the average number of lines shown in Edwin’s view.
TInt  AvgCharsPerLine () const
  Gets the average number of characters on a line.
void  SetAvgLinesInViewRect (TInt aAvgLines)
  Sets the average number of lines displayed in Edwin’s view.
void  SetAvgCharsPerLine (TInt aAvgChars)
  Sets the average number of characters per line.
IMPORT_C void  SetEdwinSizeObserver (MEikEdwinSizeObserver *aEdwinSizeObserver)
  Sets the Edwin size observer.
IMPORT_C TInt  MinimumHeight () const
  Gets the minimum Edwin height.
IMPORT_C TInt  MaximumHeight () const
  Gets the maximum Edwin height.
IMPORT_C void  SetMinimumHeight (TInt aHeight)
  Sets the minimum Edwin height.
IMPORT_C void  SetMaximumHeight (TInt aHeight)
  Sets the maximum Edwin height.
IMPORT_C void  InsertDeleteCharsL (TInt aInsertPos, const TDesC &aText, const TCursorSelection &aDelete)
  Replaces the cursor selection with the identified text.
IMPORT_C void  SetNonPrintingCharsVisibility (TNonPrintingCharVisibility aVisibility)
  Sets non-printing characters’ visibility.
IMPORT_C TNonPrintingCharVisibility  NonPrintingCharsVisibility () const
  Sets non-printing characters’ visibility.
IMPORT_C void  SetAvkonWrap (TBool aAvkonWrapIsOn)
  Sets the EAvkonEditor flag.
IMPORT_C void  SetAknEditorCase (TInt aCase)
  Sets default case for the editor.
IMPORT_C void  SetAknEditorPermittedCaseModes (TInt aPermittedCaseModes)
  Sets permitted cases for the editor.
IMPORT_C void  SetAknEditorNumericKeymap (TAknEditorNumericKeymap aNumericKeymap)
  Sets number mode key mapping for '*' and '#' keys.
IMPORT_C void  SetAknEditorInputMode (TInt aInputMode)
  Sets default input mode for the editor.
IMPORT_C void  SetAknEditorAllowedInputModes (TInt aInputModes)
  Sets allowed input modes for the editor.
IMPORT_C void  SetAknEditorSpecialCharacterTable (TInt aSCTResId)
  Sets editor specific special character table.
IMPORT_C void  SetAknEditorFlags (TInt aFlags)
  Sets initial editor flags for the editor.
IMPORT_C void  EnableCcpuSupportL (TBool aSupport)
  Enables or disables CCPU interface provided functionalities (cut, copy, paste and undo).
IMPORT_C void  SetAknEditorCurrentInputMode (TInt aInputMode)
  Updates editor input mode.
IMPORT_C TInt  AknEditorCurrentInputMode ()
  Returns the input mode that has been saved to editor state.
IMPORT_C void  SetAknEditorCurrentCase (TInt aCase)
  Updates editor case.
IMPORT_C void  SetAknEditorLocalLanguage (TLanguage aLanguage)
  Sets new local input language for the editor.
IMPORT_C void  NotifyEditorStateObserverOfStateChangeL ()
  This call causes FEP to reset current editing state and new editing state is fetched from CAknEdwinState object.
IMPORT_C void  SetSuppressBackgroundDrawing (TBool aSuppress)
  Used for suppressing all editor's background drawing.
IMPORT_C TBool  IsBackgroundDrawingSuppressed () const
  Tests if the background drawing is suppressed.
IMPORT_C void  SetTextLinesRect (const TRect &aRect)
  Used to prevent partial text lines from being drawn.
IMPORT_C void  SetScrollRect (const TRect &aRect)
  Used to determine which area is used for scrolling.
IMPORT_C TRect  GetTextLinesRect () const
  Gets the rectangle set for drawing only full lines.
IMPORT_C void  SetMaximumHeightInLines (TInt aLines)
  Sets editor's maximum height in lines.
IMPORT_C TInt  MaximumHeightInLines () const
  Gets editor maximum height in lines.
IMPORT_C TBool  CcpuIsFocused () const
  Tests whether the editor is focused.
IMPORT_C TBool  CcpuCanCut () const
  Tests whether the selected text can be cut.
IMPORT_C void  CcpuCutL ()
  Cuts selected text.
IMPORT_C TBool  CcpuCanCopy () const
  Tests whether the selected text can be copied.
IMPORT_C void  CcpuCopyL ()
  Copies selected text.
IMPORT_C TBool  CcpuCanPaste () const
  Tests whether text can be pasted from the clipboard.
IMPORT_C void  CcpuPasteL ()
  Pastes text from the clipboard to the editor.
IMPORT_C TBool  CcpuCanUndo () const
  Tests is it possible to undo previous operation.
IMPORT_C void  CcpuUndoL ()
  Undoes the most recent text operation when the Edwin supports this feature and when the undo store is not empty.
IMPORT_C TInt  AknEdwinFlags () const
  Gets edwin's flags from CAknEdwinState.
IMPORT_C void  CreateTextViewL ()
  Allocates memory for the Edwin text view.
IMPORT_C CTextView *  TextView () const
  Gets Edwin text view.
IMPORT_C CTextLayout *  TextLayout () const
  Gets Edwins text layout.
IMPORT_C TBool  SetUndoBufferL (const TCursorSelection &aSelection)
  Sets undo buffer for the Edwin.
IMPORT_C void  SetUndoableText (const TCursorSelection &aSelection)
  Sets new undoable text to the undo buffer.
CAknEdwinState EditorState () const
  Gets the editor state.
void  SetMaxLength (TInt aLength)
  Sets maximum length for the editor.
TInt  MaxLength () const
  Gets the editor maximum length.
IMPORT_C void  AddFlagToUserFlags (TUint32 aFlag)
  Adds user flags.
IMPORT_C void  RemoveFlagFromUserFlags (TUint32 aFlag)
  Removes user flags.
IMPORT_C TUint32  UserFlags () const
  Gets user flags.
IMPORT_C void  SetCharFormatLayer (CCharFormatLayer *aCharFormatLayer)
  Sets the character format layer for the editor.
IMPORT_C void  SetParaFormatLayer (CParaFormatLayer *aParaFormatLayer)
  Sets the paragraph format layer for the editor.
IMPORT_C void  SetSkinBackgroundControlContextL (MAknsControlContext *aContext)
  Sets within in the editor an externally owned Skins background control context.
MAknsControlContext SkinBackgroundControlContext () const
  Access to Skins background control context that is potentially being used by the Editor.
TBool  SkinEnabled () const
  Access to disposition of the editor to perform Skinning.
IMPORT_C void  SetAlignment (TInt aAlignment)
  Stores the alignment value for an editor.
void  DrawTextView () const
  Redraws text view.
IMPORT_C void  SetPictographAnimationCallBack (TCallBack &aCallBack)
  Sets the callback, which the editor calls after having redrawn itself for animated pictographs.
const TCallBack &  PictographAnimationCallBack () const
  Returns pictograph animation callback.
IMPORT_C void  SetUpperFullFormattingLength (TInt aUpperFullFormattingLimit)
  This method sets the upper limit of full document formatting.
IMPORT_C void  SetSuppressNotifyDraw (TBool aEnabled)
  Can be called to inhibit redrawing of the editor when NotifyNewFormatL() is called.
IMPORT_C void  SetSuppressFormatting (TBool aSuppressed)
  Can be called to inhibit formatting of the editor.
IMPORT_C void  SetTextSkinColorIdL (TInt aAknSkinIdForTextColor)
  Sets skin id for text.
IMPORT_C void  SetHighlightStyleL (TAknsHighlightStyle aStyle)
  Sets highlight style.
TInt  SkinColorId () const
  Gets skin id.
TAknsHighlightStyle  HighlightStyle () const
  Gets highlight style.
TRgb  EditorBackgroundColor (TRgb &aConditionalColor) const
  Called to determine the background color to draw.

Static Public Member Functions

static IMPORT_C TInt  IdleL (TAny *aPtr)
  Uses SetScrollBarsL() to set the scrollbars.

Protected Types

enum   TEnd { EStart, EEnd }
  Specifies the end points of the editable area. More...
enum   TChunkSize { EChunkWord, EChunkPara }
  Specifies the chunk size as either a word, or a paragraph. More...
enum   TEikEdwinFlags {
  ERichText = 0x00000001, EDragDouble = 0x00000002, ELeftDownInViewRect = 0x00000004, ENumericCharacters = 0x00000008,
  EHasOneLineOnly = 0x00000010, EPhoneNumberGrouping = 0x00000020, ESuppressNotifyDraw = 0x00000040, ESuppressFormatting = 0x00000080
}
  Specifies the chunk size as either a word, or a paragraph. More...

Protected Member Functions

IMPORT_C void  EditObserver (TInt aStartEdit, TInt aEditLength)
  From MEditObserver.
IMPORT_C void  TrappedDraw (const TRect &aRect) const
  Draws the visible text and the cursor for DrawL(), but does not draw the border.
IMPORT_C void  DrawContents ()
  Draws the visible text and the cursor.
IMPORT_C void  BaseConstructL ()
  Completes the second-phase construction of a CEikEdwin object.
IMPORT_C void  FormatTextL ()
  Formats all the text in the text view.
IMPORT_C TInt  DeleteHighlightL (TBool &aChanged, TBool aIsBackSpace=EFalse, TBool aPromptConfirmation=ETrue)
  Deletes the text under the cursor selection, also cancelling the selection.
IMPORT_C TBool  OkToDeleteSelectionL ()
  Confirms whether the deletion of the user’s selection is required.
IMPORT_C void  DeleteL (TBool &aChanged, const TCursorSelection &aSelection, TBool aIsBackSpace=EFalse, TBool aAllowUndo=ETrue)
  Deletes the cursor’s selection.
IMPORT_C void  TrappedSizeChanged ()
  Handles errors that occur when handling a change in Edwin’s size.
IMPORT_C void  HandleSizeChangedL ()
  Handles a change in Edwin’s size.
IMPORT_C void  CancelSelectionL (TEnd aEndOfSelectionToLeaveCursor)
  Cancels the selection and any FEP composition text.
IMPORT_C void  MoveCursorToChunkStartL (TBool aSelect, TChunkSize aChunkSize, TEnd aEndScanningTowards)
  Moves the cursor to the beginning of the next word or paragraph.
IMPORT_C void  CancelInsertCharFormat ()
  Cancels the insertion of a character format.
IMPORT_C void  PlaceDataOnClipboardL ()
  Copies the contents of the cursor selection onto the clipboard.
IMPORT_C void  ReportEdwinEventL (MEikEdwinObserver::TEdwinEvent aEventType)
  Reports an Edwin event of the specified type.
IMPORT_C void  SetLineCursorDetailsL ()
  Sets margin widths and line cursor width.
virtual IMPORT_C void  CopyDocumentContentL (CGlobalText &aInText, CGlobalText &aOutText)
  Replaces the current Edwin text.
IMPORT_C void  DisplayFindTextNotFound (TDes &aFindText)
  Displays an information message to indicate that the specified text could not be found.
virtual IMPORT_C void  HandleTextPastedL (TInt aStartPos, TInt &aLength)
  Not implemented.
virtual IMPORT_C CLafEdwinCustomDrawBase *  CreateCustomDrawL ()
  Creates a new CLafEdwinCustomDrawBase instance.
IMPORT_C void  ReadAknResourceL (TResourceReader &aReader)
  Used in ConstructFromResourceL().
IMPORT_C void  CreateLayoutL (MLayDoc *aLayDoc)
  Creates new text layout.
IMPORT_C void  CreateTextAndLayoutL (CParaFormatLayer *aParaFormatLayer, CCharFormatLayer *aCharFormatLayer)
  Creates new instance of CGlobalText and text layout based on it.
IMPORT_C void  CheckEdwinExtensionL ()
  Checks that is Edwin's extension created.
IMPORT_C CEikEdwinExtension *  EdwinExtension ()
  Gets Edwin's extension.
IMPORT_C TTypeUid::Ptr  MopSupplyObject (TTypeUid aId)
  From MObjectProvider.

Protected Attributes

TUint32  iEdwinUserFlags
  Edwin user flags.
TUint32  iEdwinInternalFlags
  Internal Edwin flags.
CPlainText *  iText
  Edwin's text content.
CTextView *  iTextView
  Edwin's text view.
CTextLayout *  iLayout
  Edwin's text layout.
TInt  iTextLimit
  Maximum length ot the edwin.
TInt  iNumberOfLines
  Number of lines in Edwin.
MGraphicsDeviceMap *  iZoomFactor
  Current zoom factor.
TInt  iLastPointerDocPos
  Cursor position.
TMargins8  iMargins
  Edwin's margins.

Friends

class  CEikEdwinFepSupport
class  CEikEdwinExtension

Data Structures

class   CEikEdwinExtension

Member Enumeration Documentation

enum CEikEdwin::TChunkSize [protected]
 

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

Enumerator:
EChunkWord  A word.
EChunkPara  A paragraph.
enum CEikEdwin::TClipboardFunc
 

Defines the possible commands for ClipboardL().

Enumerator:
ENoClipboard  Do nothing.
ECut  Cut.
ECopy  Copy.
EPaste  Paste.
enum CEikEdwin::TEdwinHotKeys
 

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.
enum CEikEdwin::TEikEdwinFlags [protected]
 

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 
enum CEikEdwin::TEnd [protected]
 

Specifies the end points of the editable area.

Enumerator:
EStart  The start of the editable area.
EEnd  The end of the editable area.
enum CEikEdwin::TFindFlags
 

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 
enum CEikEdwin::TFlags
 

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.
enum CEikEdwin::TOwnershipType
 

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.
enum CEikEdwin::TSetContent
 

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.

Constructor & Destructor Documentation

IMPORT_C CEikEdwin::~CEikEdwin  ) 
 

Destructor.

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

IMPORT_C CEikEdwin::CEikEdwin  ) 
 

C++ default constructor.

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

IMPORT_C CEikEdwin::CEikEdwin const TGulBorder &  aBorder  ) 
 

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.

Member Function Documentation

IMPORT_C void CEikEdwin::ActivateL  ) 
 

From CCoeControl.

Sets the Edwin as ready for drawing.

Leave:
KErrNoMemory.

Reimplemented in CEikGlobalTextEditor, and CEikRichTextEditor.

IMPORT_C void CEikEdwin::AddEdwinObserverL MEikEdwinObserver aEdwinObserver  ) 
 

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.
IMPORT_C void CEikEdwin::AddFlagToUserFlags TUint32  aFlag  ) 
 

Adds user flags.

See TFlags.

Parameters:
aFlag  Flags to add.
IMPORT_C TInt CEikEdwin::AknEditorCurrentInputMode  ) 
 

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

Returns:
Input Mode that is saved to editor state.
IMPORT_C TInt CEikEdwin::AknEdwinFlags  )  const
 

Gets edwin's flags from CAknEdwinState.

Returns:
The control's flags.
TInt CEikEdwin::AvgCharsPerLine  )  const [inline]
 

Gets the average number of characters on a line.

Returns:
The average number of characters on a line.
TInt CEikEdwin::AvgLinesInViewRect  )  const [inline]
 

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

Returns:
The average number of lines.
IMPORT_C void CEikEdwin::BaseConstructL  )  [protected]
 

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.

IMPORT_C void CEikEdwin::CalculateWidth TInt  aWidthInChars  ) 
 

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.
IMPORT_C void CEikEdwin::CancelFepTransaction  ) 
 

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.

IMPORT_C void CEikEdwin::CancelInsertCharFormat  )  [protected]
 

Cancels the insertion of a character format.

This can be used for rich text only.

IMPORT_C void CEikEdwin::CancelSelectionL TEnd  aEndOfSelectionToLeaveCursor  )  [protected]
 

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.
IMPORT_C TBool CEikEdwin::CanUndo  )  const
 

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.
IMPORT_C TBool CEikEdwin::CcpuCanCopy  )  const [virtual]
 

Tests whether the selected text can be copied.

Returns:
ETrue if it is possible to copy the selected text.

Implements MEikCcpuEditor.

IMPORT_C TBool CEikEdwin::CcpuCanCut  )  const [virtual]
 

Tests whether the selected text can be cut.

Returns:
ETrue if it is possible to cut the selected text.

Implements MEikCcpuEditor.

IMPORT_C TBool CEikEdwin::CcpuCanPaste  )  const [virtual]
 

Tests whether text can be pasted from the clipboard.

Returns:
ETrue if it is possible to paste the clipboard text.

Implements MEikCcpuEditor.

IMPORT_C TBool CEikEdwin::CcpuCanUndo  )  const [virtual]
 

Tests is it possible to undo previous operation.

Returns:
ETrue if it is possible to undo previous operation.

Implements MEikCcpuEditor.

IMPORT_C void CEikEdwin::CcpuCopyL  )  [virtual]
 

Copies selected text.

Implements MEikCcpuEditor.

IMPORT_C void CEikEdwin::CcpuCutL  )  [virtual]
 

Cuts selected text.

Implements MEikCcpuEditor.

IMPORT_C TBool CEikEdwin::CcpuIsFocused  )  const [virtual]
 

Tests whether the editor is focused.

Returns:
If editor is focused, ETrue is returned.

Implements MEikCcpuEditor.

IMPORT_C void CEikEdwin::CcpuPasteL  )  [virtual]
 

Pastes text from the clipboard to the editor.

Implements MEikCcpuEditor.

IMPORT_C void CEikEdwin::CcpuUndoL  )  [virtual]
 

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

Implements MEikCcpuEditor.

IMPORT_C void CEikEdwin::CheckEdwinExtensionL  )  [protected]
 

Checks that is Edwin's extension created.

If not, it will be created.

Leave:
KErrNoMemory If the Edwin FEP support pointer is NULL.
IMPORT_C void CEikEdwin::CheckNotReadOnlyL  ) 
 

Determines whether the document being edited is read only.

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

IMPORT_C void CEikEdwin::CheckRemovePictures TInt  aStartPos,
TInt  aLength
 

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.
IMPORT_C void CEikEdwin::CheckValidityOfChars TInt  aStartPos,
TInt  aLength
 

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.
IMPORT_C void CEikEdwin::ClearSelectionL  ) 
 

Removes the selection and any composition text.

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

IMPORT_C void CEikEdwin::ClearUndo  ) 
 

Deletes the undo store.

IMPORT_C void CEikEdwin::ClipboardL TClipboardFunc  aClipboardFunc  ) 
 

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.
IMPORT_C void CEikEdwin::ConstructFromResourceL TResourceReader &  aReader  ) 
 

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.

IMPORT_C void CEikEdwin::ConstructL TInt  aEdwinFlags = 0,
TInt  aWidthInChars = 0,
TInt  aTextLimit = 0,
TInt  aNumberOfLines = 0
 

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.
virtual IMPORT_C void CEikEdwin::CopyDocumentContentL CGlobalText &  aInText,
CGlobalText &  aOutText
[protected, virtual]
 

Replaces the current Edwin text.

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

Reimplemented in CEikRichTextEditor.

IMPORT_C void CEikEdwin::CopyToStoreL CStreamStore &  aStore,
CStreamDictionary &  aDict
 

Copies the highlighted text into a stream store.

Parameters:
[out]  aStore  Store to write to.
[in]  aDict  Stream dictionary.
IMPORT_C TInt CEikEdwin::CountWords  ) 
 

Counts and returns the number of words in the document.

Returns:
The number of words in the document.
virtual IMPORT_C CLafEdwinCustomDrawBase* CEikEdwin::CreateCustomDrawL  )  [protected, virtual]
 

Creates a new CLafEdwinCustomDrawBase instance.

Returns:
Pointer to new custom CLafEdwinCustomDrawBase object.
IMPORT_C void CEikEdwin::CreateLayoutL MLayDoc *  aLayDoc  )  [protected]
 

Creates new text layout.

Parameters:
aLayDoc  Pointer to the MLayDoc implementation that is the source of the text and formatting information.
CEikScrollBarFrame * CEikEdwin::CreatePreAllocatedScrollBarFrameL  )  [inline]
 

Creates a pre-allocated scroll bar frame.

Returns:
Pre-allocated scroll bar frame.
IMPORT_C CEikScrollBarFrame* CEikEdwin::CreateScrollBarFrameL  ) 
 

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

Returns:
The scroll bar frame.
IMPORT_C void CEikEdwin::CreateTextAndLayoutL CParaFormatLayer *  aParaFormatLayer,
CCharFormatLayer *  aCharFormatLayer
[protected]
 

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.
IMPORT_C void CEikEdwin::CreateTextViewL  ) 
 

Allocates memory for the Edwin text view.

IMPORT_C TInt CEikEdwin::CursorPos  )  const
 

Gets the cursor’s position within the document.

Returns:
The cursor’s position within the document.
IMPORT_C TInt CEikEdwin::DeleteHighlightL TBool &  aChanged,
TBool  aIsBackSpace = EFalse,
TBool  aPromptConfirmation = ETrue
[protected]
 

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.
IMPORT_C void CEikEdwin::DeleteL TBool &  aChanged,
const TCursorSelection &  aSelection,
TBool  aIsBackSpace = EFalse,
TBool  aAllowUndo = ETrue
[protected]
 

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.
IMPORT_C void CEikEdwin::DisplayFindTextNotFound TDes &  aFindText  )  [protected]
 

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.
IMPORT_C void CEikEdwin::Draw const TRect &  aRect  )  const
 

From CCoeControl.

Draws the control on request.

Parameters:
aRect  If supplied, the rectangle in which to draw the Edwin.

Reimplemented from CEikBorderedControl.

IMPORT_C void CEikEdwin::DrawContents  )  [protected]
 

Draws the visible text and the cursor.

void CEikEdwin::DrawTextView  )  const
 

Redraws text view.

Used for pictograph animations.

IMPORT_C void CEikEdwin::EditObserver TInt  aStartEdit,
TInt  aEditLength
[protected]
 

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.

TRgb CEikEdwin::EditorBackgroundColor TRgb &  aConditionalColor  )  const
 

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.
CAknEdwinState* CEikEdwin::EditorState  )  const
 

Gets the editor state.

Returns:
Pointer to editor state object.
IMPORT_C CEikEdwinExtension* CEikEdwin::EdwinExtension  )  [protected]
 

Gets Edwin's extension.

Returns:
Pointer to Edwin's extension.
IMPORT_C void CEikEdwin::EnableCcpuSupportL TBool  aSupport  ) 
 

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

Parameters:
aSupport  CCPU support enabled if ETrue.
IMPORT_C TBool CEikEdwin::FindL const TDesC *  aFindText,
TInt  aFindFlags = 0
 

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.
IMPORT_C TInt CEikEdwin::FindTextL const TDesC *  aFindText,
TInt  aPos,
TInt  aFindFlags
 

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.
IMPORT_C void CEikEdwin::FocusChanged TDrawNow  aDrawNow  ) 
 

From CCoeControl.

Responds to focus-changed events.

Parameters:
aDrawNow  Not used.
IMPORT_C void CEikEdwin::ForceScrollBarUpdateL  ) 
 

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

IMPORT_C void CEikEdwin::FormatTextL  )  [protected]
 

Formats all the text in the text view.

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

virtual IMPORT_C void CEikEdwin::GetColorUseListL CArrayFix< TCoeColorUse > &  aColorUseList  )  const [virtual]
 

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.

IMPORT_C void CEikEdwin::GetFindText TDes *  aFindText  ) 
 

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.
IMPORT_C void CEikEdwin::GetText TDes &  aDes  )  const
 

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.
IMPORT_C HBufC* CEikEdwin::GetTextInHBufL  )  const
 

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

Returns:
A new copy of the document text.
IMPORT_C TRect CEikEdwin::GetTextLinesRect  )  const
 

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
IMPORT_C void CEikEdwin::GetWordInfo TInt  aCurrentPos,
TInt &  aStartPos,
TInt &  aLength
const
 

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.
IMPORT_C void CEikEdwin::HandlePointerEventL const TPointerEvent &  aPointerEvent  ) 
 

From CCoeControl.

Handles pointer events.

Parameters:
aPointerEvent  Pointer event to respond to.

Reimplemented from CEikBorderedControl.

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

virtual IMPORT_C void CEikEdwin::HandleResourceChange TInt  aType  )  [virtual]
 

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.

IMPORT_C void CEikEdwin::HandleScrollEventL CEikScrollBar aScrollBar,
TEikScrollEvent  aEventType
[virtual]
 

From MEikScrollBarObserver.

Handles scrollbar key events.

Parameters:
aScrollBar  The scrollbar.
aEventType  The type of key event.

Implements MEikScrollBarObserver.

IMPORT_C void CEikEdwin::HandleSizeChangedL  )  [protected]
 

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.

IMPORT_C void CEikEdwin::HandleTextChangedL  ) 
 

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.

virtual IMPORT_C void CEikEdwin::HandleTextPastedL TInt  aStartPos,
TInt &  aLength
[protected, virtual]
 

Not implemented.

Parameters:
aStartPos  Not used.
aLength  Not used.
TAknsHighlightStyle CEikEdwin::HighlightStyle  )  const
 

Gets highlight style.

Returns:
The highlight style.
static IMPORT_C TInt CEikEdwin::IdleL TAny *  aPtr  )  [static]
 

Uses SetScrollBarsL() to set the scrollbars.

Parameters:
aPtr  Pointer to CEikEdwin instance.
Returns:
Integer value of EFalse.
IMPORT_C TCoeInputCapabilities CEikEdwin::InputCapabilities  )  const
 

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.

IMPORT_C void CEikEdwin::InsertDeleteCharsL TInt  aInsertPos,
const TDesC &  aText,
const TCursorSelection &  aDelete
 

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.
IMPORT_C void CEikEdwin::InsertFieldL CTextField *  aField,
TUid  aFieldType
 

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.
IMPORT_C void CEikEdwin::InsertFromTextFileL const TFileName &  aFileName,
const CPlainText::TTextOrganisation  aTextOrganisation = CPlainText::EOrganiseByLine
 

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.
IMPORT_C TBool CEikEdwin::IsBackgroundDrawingSuppressed  )  const
 

Tests if the background drawing is suppressed.

Returns:
ETrue if the background drawing is suppressed
IMPORT_C TBool CEikEdwin::IsReadOnly  )  const
 

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

Returns:
ETrue if the document being edited is read-only. EFalse otherwise.
IMPORT_C TInt CEikEdwin::LayoutWidth  )  const
 

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.
virtual IMPORT_C TInt CEikEdwin::LineCursorWidth  )  const [virtual]
 

Gets the width of a line cursor in pixels.

Returns:
Always 0.

Reimplemented in CEikGlobalTextEditor.

IMPORT_C TInt CEikEdwin::LowerPartialFormattingLength  )  const
 

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.
IMPORT_C TMargins8 CEikEdwin::Margins  )  const
 

Gets the text view margins.

Returns:
The text view margins.
IMPORT_C TInt CEikEdwin::MaximumHeight  )  const
 

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.
IMPORT_C TInt CEikEdwin::MaximumHeightInLines  )  const
 

Gets editor maximum height in lines.

Returns:
Maximum height in lines.
TInt CEikEdwin::MaxLength  )  const [inline]
 

Gets the editor maximum length.

Returns:
The editor maximum length
IMPORT_C TInt CEikEdwin::MinimumHeight  )  const
 

Gets the minimum Edwin height.

Returns:
The minimum Edwin height.
IMPORT_C TSize CEikEdwin::MinimumSize  ) 
 

From CCoeControl.

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

Returns:
Minimum size for the control.
IMPORT_C TTypeUid::Ptr CEikEdwin::MopSupplyObject TTypeUid  aId  )  [protected]
 

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.
IMPORT_C void CEikEdwin::MoveCursorL TCursorPosition::TMovementType  aMovement,
TBool  aSelect
 

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.
IMPORT_C void CEikEdwin::MoveCursorToChunkStartL TBool  aSelect,
TChunkSize  aChunkSize,
TEnd  aEndScanningTowards
[protected]
 

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.
IMPORT_C void CEikEdwin::MoveDisplayL TCursorPosition::TMovementType  aMovement  ) 
 

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

Parameters:
aMovement  The cursor's movement.
IMPORT_C TNonPrintingCharVisibility CEikEdwin::NonPrintingCharsVisibility  )  const
 

Sets non-printing characters’ visibility.

Returns:
Non-printing characters’ visibility.
IMPORT_C void CEikEdwin::NotifyEditorStateObserverOfStateChangeL  ) 
 

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

IMPORT_C void CEikEdwin::NotifyNewDocumentL  ) 
 

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

IMPORT_C void CEikEdwin::NotifyNewFormatL  ) 
 

Reformats and redraws the document, updates scrollbars if necessary.

IMPORT_C TKeyResponse CEikEdwin::OfferKeyEventL const TKeyEvent &  aKeyEvent,
TEventCode  aType
 

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.

IMPORT_C TBool CEikEdwin::OkToDeleteSelectionL  )  [protected]
 

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.
IMPORT_C TBool CEikEdwin::OnlyASCIIChars  )  const
 

Tests whether the EOnlyASCIIChars flag is set.

Returns:
ETrue if the EOnlyASCIIChars flag is set.
IMPORT_C void CEikEdwin::OnReformatL const CTextView *  aTextView  ) 
 

From CTextView::MObserver.

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

Parameters:
aTextView  Not used.
IMPORT_C void CEikEdwin::PasteFromStoreL CStreamStore &  aStore,
CStreamDictionary &  aDict
 

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.
const TCallBack& CEikEdwin::PictographAnimationCallBack  )  const
 

Returns pictograph animation callback.

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

Returns:
Pictograph animation callback
IMPORT_C void CEikEdwin::PlaceDataOnClipboardL  )  [protected]
 

Copies the contents of the cursor selection onto the clipboard.

IMPORT_C void CEikEdwin::ReadAknResourceL TResourceReader &  aReader  )  [protected]
 

Used in ConstructFromResourceL().

Sets Avkon editor properties.

Parameters:
aReader  A reader positioned for reading from an EDWIN resource.
IMPORT_C void CEikEdwin::ReceiveDataOverIrL  ) 
 

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.

IMPORT_C void CEikEdwin::RemoveEdwinObserver MEikEdwinObserver aEdwinObserver  ) 
 

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.
IMPORT_C void CEikEdwin::RemoveFlagFromUserFlags TUint32  aFlag  ) 
 

Removes user flags.

See TFlags.

Parameters:
aFlag  Flags to remove.
IMPORT_C void CEikEdwin::ReplaceAllL SEdwinFindModel aFindModel  ) 
 

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.
IMPORT_C void CEikEdwin::ReplaceL SEdwinFindModel aFindModel  ) 
 

Replaces the highlighted text.

See SEdwinFindModel struct.

Parameters:
[in,out]  aFindModel  Pointer to the replacement text.
IMPORT_C void CEikEdwin::ReportEdwinEventL MEikEdwinObserver::TEdwinEvent  aEventType  )  [protected]
 

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.
IMPORT_C void CEikEdwin::RunCharMapDialogL  ) 
 

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.

CEikScrollBarFrame * CEikEdwin::ScrollBarFrame  )  [inline]
 

Gets the scroll bar frame surrounding this Edwin.

Returns:
Pointer to this Edwin’s scroll bar frame.
IMPORT_C void CEikEdwin::SelectAllL  ) 
 

Selects the entire document.

IMPORT_C TCursorSelection CEikEdwin::Selection  )  const
 

Gets the cursor selection.

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

Returns:
The current selection.
IMPORT_C TInt CEikEdwin::SelectionLength  )  const
 

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

Returns:
The number of characters within the selection.
IMPORT_C void CEikEdwin::SendDataOverIrL  ) 
 

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

IMPORT_C void CEikEdwin::SetAknEditorAllowedInputModes TInt  aInputModes  ) 
 

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.
IMPORT_C void CEikEdwin::SetAknEditorCase TInt  aCase  ) 
 

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.
IMPORT_C void CEikEdwin::SetAknEditorCurrentCase TInt  aCase  ) 
 

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.
IMPORT_C void CEikEdwin::SetAknEditorCurrentInputMode TInt  aInputMode  ) 
 

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.
IMPORT_C void CEikEdwin::SetAknEditorFlags TInt  aFlags  ) 
 

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.
IMPORT_C void CEikEdwin::SetAknEditorInputMode TInt  aInputMode  ) 
 

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.
IMPORT_C void CEikEdwin::SetAknEditorLocalLanguage TLanguage  aLanguage  ) 
 

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.
IMPORT_C void CEikEdwin::SetAknEditorNumericKeymap TAknEditorNumericKeymap  aNumericKeymap  ) 
 

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.
IMPORT_C void CEikEdwin::SetAknEditorPermittedCaseModes TInt  aPermittedCaseModes  ) 
 

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.
IMPORT_C void CEikEdwin::SetAknEditorSpecialCharacterTable TInt  aSCTResId  ) 
 

Sets editor specific special character table.

Parameters:
aSCTResId  Special character table dialog resource.
IMPORT_C void CEikEdwin::SetAlignment TInt  aAlignment  ) 
 

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
IMPORT_C void CEikEdwin::SetAllowPictures TBool  aAllow  ) 
 

Sets whether the document accepts pictures.

Parameters:
aAllow  ETrue sets the document to accept pictures, EFalse sets the document to not accept pictures.
IMPORT_C void CEikEdwin::SetAllowUndo TBool  aAllow  ) 
 

Sets whether the undo operation is permitted.

Parameters:
aAllow  ETrue to permit undo operations. EFalse to not permit undo operations.
IMPORT_C void CEikEdwin::SetAmountToFormatL TBool  aIsNewDoc,
TBool  aReFormat
 

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
IMPORT_C void CEikEdwin::SetAmountToFormatL TBool  aIsNewDoc = EFalse  ) 
 

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
void CEikEdwin::SetAvgCharsPerLine TInt  aAvgChars  )  [inline]
 

Sets the average number of characters per line.

Parameters:
aAvgChars  The average number of characters per line.
void CEikEdwin::SetAvgLinesInViewRect TInt  aAvgLines  )  [inline]
 

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

Parameters:
aAvgLines  The average number of lines to display.
IMPORT_C void CEikEdwin::SetAvkonWrap TBool  aAvkonWrapIsOn  ) 
 

Sets the EAvkonEditor flag.

Parameters:
aAvkonWrapIsOn  If ETrue EAvkonEditor flag is set.
IMPORT_C void CEikEdwin::SetBackgroundColorL TRgb  aBackground  ) 
 

Sets the Edwin’s background colour.

Parameters:
aBackground  New value for the background colour.
IMPORT_C void CEikEdwin::SetBorderViewMargins TMargins8  aMargins  ) 
 

Sets the text view margins.

Parameters:
aMargins  New value for the view’s margins.
IMPORT_C void CEikEdwin::SetCharFormatLayer CCharFormatLayer *  aCharFormatLayer  ) 
 

Sets the character format layer for the editor.

Parameters:
aCharFormatLayer  Pointer to the character format layer object.
IMPORT_C void CEikEdwin::SetContainerWindowL const CCoeControl &  aParent  ) 
 

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.
IMPORT_C void CEikEdwin::SetContainerWindowL  ) 
 

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

IMPORT_C void CEikEdwin::SetCursorPosL TInt  aCursorPos,
TBool  aSelect
 

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.
IMPORT_C void CEikEdwin::SetDimmed TBool  aDimmed  ) 
 

From CCoeControl.

Dims or undims the Edwin.

Parameters:
aDimmed  ETrue to dim the Edwin. EFalse to undim the Edwin.
IMPORT_C void CEikEdwin::SetDocumentContentL CGlobalText &  aText,
TSetContent  aContent = CEikEdwin::ECopyText
 

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.
IMPORT_C void CEikEdwin::SetDocumentOwnership TOwnershipType  aOwner  ) 
 

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.
IMPORT_C void CEikEdwin::SetEdwinObserver MEikEdwinObserver aEdwinObserver  ) 
 

Sets the Edwin observer.

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

Parameters:
aEdwinObserver  New observer.
IMPORT_C void CEikEdwin::SetEdwinSizeObserver MEikEdwinSizeObserver aEdwinSizeObserver  ) 
 

Sets the Edwin size observer.

Does not imply transfer of ownership.

Parameters:
aEdwinSizeObserver  The Edwin size observer.
IMPORT_C void CEikEdwin::SetHighlightStyleL TAknsHighlightStyle  aStyle  ) 
 

Sets highlight style.

Parameters:
aStyle  The highlight style.
IMPORT_C void CEikEdwin::SetInputCapabilitiesL const TCoeInputCapabilities &  aInputCapabilities  ) 
 

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.
IMPORT_C void CEikEdwin::SetLineCursorDetailsL  )  [protected]
 

Sets margin widths and line cursor width.

IMPORT_C void CEikEdwin::SetMaximumHeight TInt  aHeight  ) 
 

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.
IMPORT_C void CEikEdwin::SetMaximumHeightInLines TInt  aLines  ) 
 

Sets editor's maximum height in lines.

Parameters:
aLines  Maximum height in lines.
void CEikEdwin::SetMaxLength TInt  aLength  )  [inline]
 

Sets maximum length for the editor.

Parameters:
aLength  Maximum length for the editor.
IMPORT_C void CEikEdwin::SetMinimumHeight TInt  aHeight  ) 
 

Sets the minimum Edwin height.

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

IMPORT_C void CEikEdwin::SetNonPrintingCharsVisibility TNonPrintingCharVisibility  aVisibility  ) 
 

Sets non-printing characters’ visibility.

Parameters:
aVisibility  Non-printing characters’ visibility.
IMPORT_C void CEikEdwin::SetOnlyASCIIChars TBool  aASCIIOnly  ) 
 

Sets the EOnlyASCIIChars flag.

Parameters:
aASCIIOnly  If ETrue the EOnlyASCIIChars flag will be set. If EFalse the EOnlyASCIIChars flag will be removed.
IMPORT_C void CEikEdwin::SetParaFormatLayer CParaFormatLayer *  aParaFormatLayer  ) 
 

Sets the paragraph format layer for the editor.

Parameters:
aParaFormatLayer  Pointer to the paragraph format layer object.
IMPORT_C void CEikEdwin::SetPasteFromIrStore TBool  aPasteFromIrStore  ) 
 

Sets the EPasteFromIrStore flag.

Parameters:
aPasteFromIrStore  ETrue to set the EPasteFromIrStore flag. EFalse to remove the EPasteFromIrStore flag.
IMPORT_C void CEikEdwin::SetPictographAnimationCallBack TCallBack &  aCallBack  ) 
 

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.
IMPORT_C void CEikEdwin::SetReadOnly TBool  aReadOnly  ) 
 

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.
IMPORT_C void CEikEdwin::SetRightWrapGutter TInt  aGap  ) 
 

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.
IMPORT_C void CEikEdwin::SetScrollRect const TRect &  aRect  ) 
 

Used to determine which area is used for scrolling.

IMPORT_C void CEikEdwin::SetSelectionL TInt  aCursorPos,
TInt  aAnchorPos
 

Sets the text selection.

Highlights the selected area and makes the new cursor position visible. Any previous selection is cancelled. This function also updates the scroll bar thumbs if present.

Parameters:
aCursorPos  The cursor’s position.
aAnchorPos  The anchor’s position.
IMPORT_C void CEikEdwin::SetSkinBackgroundControlContextL MAknsControlContext aContext  ) 
 

Sets within in the editor an externally owned Skins background control context.

This background control context will then be used by the editor to draw background.

If this API is not called, then the editor IS skin enabled, (that is CEikEdwins are skin enabled by default) but it will try to find a control context with which to perform background drawing from the Control Environment, via the Object Provider.

Setting this control context to NULL will have the effect of turning off background skinning.

Parameters:
aContext  Control context to store. Not owned. Can be NULL.
IMPORT_C void CEikEdwin::SetSuppressBackgroundDrawing TBool  aSuppress  ) 
 

Used for suppressing all editor's background drawing.

This is intended for internal use.

Note that when this is set, the background is not drawn with skin nor cleared, so the background MUST be drawn by the parent control every time the editor changes.

Parameters:
aSuppress  If ETrue, suppress background drawing
IMPORT_C void CEikEdwin::SetSuppressFormatting TBool  aSuppressed  ) 
 

Can be called to inhibit formatting of the editor.

Care is required to ensure that the necessary reformatting is carried out later on if this API is used.

Note: When called with EFalse, it does not automatically trigger reformatting.

Parameters:
aSuppressed  If ETrue, inhibit formatting from now on, if EFalse, re-enable formatting from now on.
IMPORT_C void CEikEdwin::SetSuppressNotifyDraw TBool  aEnabled  ) 
 

Can be called to inhibit redrawing of the editor when NotifyNewFormatL() is called.

Parameters:
aEnabled  If ETrue, inhibit redrawing when notified of new format from now on.
IMPORT_C void CEikEdwin::SetTextL const TDesC *  aDes  ) 
 

Sets the document text of this Edwin from the contents of a descriptor.

This function removes any pictures, any invalid characters and cancels any previous selection.

Parameters:
aDes  Descriptor from which to copy.
IMPORT_C void CEikEdwin::SetTextLimit TInt  aLimit  ) 
 

Sets the maximum number of characters that can be inserted.

Parameters:
aLimit  New maximum for the number of characters that can be inserted.
IMPORT_C void CEikEdwin::SetTextLinesRect const TRect &  aRect  ) 
 

Used to prevent partial text lines from being drawn.

The client is responsible for giving a sane value. An empty rect disables this feature. This is intended for internal use.

Parameters:
aRect  The rect which contains text lines to be drawn
IMPORT_C void CEikEdwin::SetTextSkinColorIdL TInt  aAknSkinIdForTextColor  ) 
 

Sets skin id for text.

Parameters:
aAknSkinIdForTextColor  The skin id.
IMPORT_C void CEikEdwin::SetUndoableText const TCursorSelection &  aSelection  ) 
 

Sets new undoable text to the undo buffer.

Parameters:
aSelection  The current selection.
IMPORT_C TBool CEikEdwin::SetUndoBufferL const TCursorSelection &  aSelection  ) 
 

Sets undo buffer for the Edwin.

Parameters:
aSelection  The current selection.
Returns:
ETrue if buffer was set.
IMPORT_C void CEikEdwin::SetUpperFullFormattingLength TInt  aUpperFullFormattingLimit  ) 
 

This method sets the upper limit of full document formatting.

At construction, the mode is full document formatting, where the text formatter processes the whole document to determine its layout.

When the text content is set, or when user input causes the length of text to exceed this value, the formatting mode switches to "Band" formatting, where the text formatter attempts to format as little as possible - optimally just the visible screen.

A lower limit is calculated from the passed-in value, by the subtraction of a constant. When the text becomes smaller than this lower limit, the formatting switches to full document formatting.

Internally-imposed limits prevent the client setting too small a value for proper operation of the text formatting.

If this method is not called, the upper and lower limts are set to a large default values.

Access to the actual limits is available via the methods UpperFullFormattingLength() and LowerPartialFormattingLength().

Parameters:
aUpperFullFormattingLimit  The upper limit of full document formatting.
IMPORT_C void CEikEdwin::SetWordDelimiters TBool  aPicture,
TBool  aPunctuation
 

Sets whether picture characters and/or punctuation should be treated as word delimiters in addition to whitespace.

Parameters:
aPicture  ETrue if picture characters should be treated as delimiters for words.
aPunctuation  ETrue if punctuation should be treated as delimiters for words.
IMPORT_C void CEikEdwin::SetWordWrapL TBool  aWrapIsOn  ) 
 

Sets word wrapping on or off.

Parameters:
aWrapIsOn  ETrue enables word wrapping, EFalse disables word wrapping.
IMPORT_C void CEikEdwin::SetWysiwygModeOff  ) 
 

Switches off the WYSIWYG mode.

This function sets the new format mode to be EFScreenMode.

IMPORT_C void CEikEdwin::SetWysiwygModeOn TInt  aLayoutWidth,
MGraphicsDeviceMap *  aDevice
 

Sets the format mode to be WYSIWYG.

Parameters:
aLayoutWidth  Formatting width in twips.
aDevice  Mapping between twips and pixels on the target device.
IMPORT_C void CEikEdwin::SetZoomFactorL TZoomFactor *  aZoomFactor  ) 
 

Sets the zoom factor of the document and reformats the document.

Parameters:
aZoomFactor  New value for the zooming factor.
MAknsControlContext* CEikEdwin::SkinBackgroundControlContext  )  const
 

Access to Skins background control context that is potentially being used by the Editor.

This API will first check to see if an control context has been set by API, and if so, return that. If the background control context has been set to NULL by API, then it will return NULL. If the background control context has never been set by API, then this returns the control context (if one exists) that the object obtains from Object Provider.

Returns:
Pointer to control context potentially in use, or NULL.
TInt CEikEdwin::SkinColorId  )  const
 

Gets skin id.

Returns:
The skin id.
TBool CEikEdwin::SkinEnabled  )  const
 

Access to disposition of the editor to perform Skinning.

This does not take into account whether the application is skin enabled or whether the environment is providing a background control context. It is only a function of whether editor's (default) disposition to skin has been countered by calls on the editor API.

Returns:
EFalse if SetSkinBackgroundControlContextL has been called with NULL in its most recent call.
IMPORT_C TBool CEikEdwin::SupportsUndo  )  const
 

Gets whether Edwin is set to support the undo command.

Returns:
ETrue if edits can be undone. EFalse if edits cannot be undone.
IMPORT_C CPlainText* CEikEdwin::Text  )  const
 

Gets a pointer to the Edwin’s document contents.

Returns:
A CPlainText pointer which contains the document.
IMPORT_C CTextLayout* CEikEdwin::TextLayout  )  const
 

Gets Edwins text layout.

Returns:
Pointer to the text layout.
IMPORT_C TInt CEikEdwin::TextLength  )  const
 

Gets the number of characters in the document.

Returns:
The number of characters in the document.
IMPORT_C CTextView* CEikEdwin::TextView  )  const
 

Gets Edwin text view.

Returns:
Pointer to the Edwin text view.
IMPORT_C void CEikEdwin::TrappedDraw const TRect &  aRect  )  const [protected]
 

Draws the visible text and the cursor for DrawL(), but does not draw the border.

The DrawL() function is trapped to handle problems due to insufficient resources being available.

Parameters:
aRect  Rectangle in which to draw.
IMPORT_C void CEikEdwin::TrappedSizeChanged  )  [protected]
 

Handles errors that occur when handling a change in Edwin’s size.

Calls CEikonEnv::NotifyIdleErrorWhileRedrawing().

IMPORT_C void CEikEdwin::UndoL  ) 
 

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

IMPORT_C void CEikEdwin::UpdateAllFieldsL  ) 
 

Updates all the fields in the document.

IMPORT_C void CEikEdwin::UpdateCurrentFieldL  ) 
 

Updates any text field at the current cursor position.

Updating involves calculating the new value for the field, and replacing the field’s existing text content with the new text.

This function does nothing if the cursor is not within a text field.

IMPORT_C void CEikEdwin::UpdateLayoutWidth TInt  aLayoutWidth  ) 
 

Updates the text wrap width.

This function is for use in WYSIWYG mode only.

Parameters:
aLayoutWidth  New width to wrap text at in WYSIWYG mode in twips.
IMPORT_C void CEikEdwin::UpdateScrollBarsL  ) 
 

Updates scrollbars.

IMPORT_C TInt CEikEdwin::UpperFullFormattingLength  )  const
 

Gets the upper limit for formatting.

This returns the value of KFullFormattingUpperThreshold which determines the maximum number of characters that can be formatted, if it is exceeded then only visible text is formatted. This is used with KPartialFormattingLowerThreshold to control the extent of text formatting.

Returns:
The value of KFullFormattingUpperThreshold.
IMPORT_C TUint32 CEikEdwin::UserFlags  )  const
 

Gets user flags.

See TFlags.

Returns:
The user flags.
IMPORT_C void CEikEdwin::WriteInternalStateL RWriteStream &  aWriteStream  )  const
 

From CCoeControl.

In debug mode writes the internal state to the given stream. Does nothing in release mode.

Parameters:
[out]  aWriteStream  A stream for writing the internal state.

Reimplemented from CEikBorderedControl.

Reimplemented in CEikGlobalTextEditor, and CEikRichTextEditor.


Friends And Related Function Documentation

friend class CEikEdwinExtension [friend]
 
friend class CEikEdwinFepSupport [friend]
 

Field Documentation

TUint32 CEikEdwin::iEdwinInternalFlags [protected]
 

Internal Edwin flags.

TUint32 CEikEdwin::iEdwinUserFlags [protected]
 

Edwin user flags.

TInt CEikEdwin::iLastPointerDocPos [protected]
 

Cursor position.

CTextLayout* CEikEdwin::iLayout [protected]
 

Edwin's text layout.

TMargins8 CEikEdwin::iMargins [protected]
 

Edwin's margins.

TInt CEikEdwin::iNumberOfLines [protected]
 

Number of lines in Edwin.

CPlainText* CEikEdwin::iText [protected]
 

Edwin's text content.

TInt CEikEdwin::iTextLimit [protected]
 

Maximum length ot the edwin.

CTextView* CEikEdwin::iTextView [protected]
 

Edwin's text view.

MGraphicsDeviceMap* CEikEdwin::iZoomFactor [protected]
 

Current zoom factor.


The documentation for this class was generated from the following file:

Copyright © Nokia Corporation 2001-2008
Back to top