EIKEDWIN.H

00001 // EIKEDWIN.H
00002 //
00003 // Copyright (c) 1997-1999 Symbian Ltd.  All rights reserved.
00004 //
00006 #if !defined(__EIKEDWIN_H__)
00007 #define __EIKEDWIN_H__
00008 
00009 #include <s32std.h>
00010 #include <gdi.h>
00011 #include <txtetext.h>
00012 #include <medobsrv.h>
00013 #include <gulutil.h>
00014 #include <fepbase.h>
00015 #include <frmvis.h>
00016 #include <frmtview.h>
00017 #include <uikon.hrh>
00018 #include <eikon.hrh>
00019 #include <eikbctrl.h>
00020 #include <eikedwob.h>
00021 #include <eiksbfrm.h>
00022 #include <eikccpu.h>
00023 #include <eiklay.h>
00024 #include <lafmain.h>
00025 #include <AknPictographDrawerInterface.h>
00026 #include <babitflags.h>
00027 #include <centralrepository.h>          // class CCenRepNotifyHandler;
00028 #include <cenrepnotifyhandler.h>        // class CRepository;
00030 class CGlobalText;
00031 class CParaFormatLayer;
00032 class CCharFormatLayer;
00033 class MLayDoc;
00034 class CEikEdwinFepSupport;
00035 class CLafEdwinCustomDrawBase;
00036 class CClipboard;
00037 class CAknEdwinFormAccessor;
00038 class CAknEdwinState;
00039 class CAknInputPolicyManager;
00040 class CFormCursorModifier;
00041 class CTextView;
00042 class MAknsControlContext;
00043 class CAknEdwinDrawingModifier;
00044 class CAknEdwinFormExtendedInterfaceProvider;
00045 class CAknPhoneNumberInlineTextSource;
00046 class CAknNoMatchesIndicatorInlineTextSource;
00047 class CAknInlineTextSource;
00048 class CAknPictographInterface;
00049 class CAknExtendedInputCapabilities;
00050 class CAknPointerEventSuppressor;
00052 // Forward declaration of now removed (Series 60 2.0) custom drawer class for CEikEdwin
00053 class CEikAvkonCustomDraw;
00055 // Forward declaration of now removed (Series 60 2.0) custom drawer class for CEikEdwin
00056 class CEikAvkonCustomDraw;
00058 // For construction of Rich Text - based custom formatters
00059 class CRichText;
00061 enum TReplaceOption
00062         {
ENoReplace,
EReplaceOnce,
EReplaceAll,
EReplaceSkip
00067         };
00075 struct SEdwinFindModel
00076         {
00078         TInt iFlags; // TEdwinFindFlags
00080         TBuf<EEikEdwinFindStringMaxLen> iText;
00082         TBuf<EEikEdwinFindStringMaxLen> iReplaceText;
00084         TReplaceOption iReplaceOption;
00085         };
00090 enum TAknsHighlightStyle
00091     {
EEikEdwinHighlightNormal = 0,
EEikEdwinHighlightLink
00096     };
00098 // inline utility to handle RGB values (set / unset)      
00100 class SAknRgb
00101     {
00102 // data (private)    
00103     TRgb iValue;
00104     TBool iIsSet;
00105 public: // utilities   
00106     SAknRgb():iIsSet(EFalse){}
00107     TRgb Value(){return iValue;}
00108     SAknRgb& operator=(TRgb aRgb)
00109         {
00110         iValue = aRgb;
00111         iIsSet = ETrue;
00112         return *this;
00113         }
00114     TBool IsSet(){return iIsSet;}
00115     };    
00127 class CEikEdwin : public CEikBorderedControl, 
00128                   public MEikScrollBarObserver, 
00129                   public CTextView::MObserver, 
00130                   public MEditObserver, 
00131                   public MEikCcpuEditor
00132         {
00134 private:
00136     class CUndoBuffer;
00137     NONSHARABLE_CLASS(CEikEdwinExtension) : public CBase, MCenRepNotifyHandlerCallback
00138         {
00139     public:
00146                 static CEikEdwinExtension* NewL(CEikEdwin* aEdwin);
00151                 ~CEikEdwinExtension();
00158                 IMPORT_C CAknEdwinFormAccessor* FormAccessor() const;
00165                 IMPORT_C void SetFormAccessor(CAknEdwinFormAccessor* aFormAccessor);
00172                 IMPORT_C void SetScrollBarSetter(CIdle* aScrollBarSetter);
00179                 IMPORT_C CIdle* ScrollBarSetter();
00186                 IMPORT_C const TAvkonEditorCustomWrap& TextWrapper();
00188                 // the following two methods are deprecated
00189         IMPORT_C CFormCursorModifier* FormCursorModifier() const;
00196         void SetSkinBackgroundControlContext( MAknsControlContext* aBackgroundControlContext );
MAknsControlContext* SkinBackgroundControlContext() const;
00212         TBool SkinBackgroundControlContextHasBeenSet() const;
00219         void SetAlignment(TInt aAlignment);
00226         TInt CurrentAlignment() const;
00231         void SetPictoCallBack( TCallBack& aCallBack );
00236         const TCallBack& PictoCallBack() const;
00241         void CreateFormExtendedInterfaceProviderIfNeededL();
00246         CAknEdwinFormExtendedInterfaceProvider* FormExtendedInferfaceProvider() const;
00257         void CreatePurePhoneNumberFormatterL( CTextLayout& aTextLayout, const CPlainText& aText);
00267         void CreateNoMatchesIndicatorFormatterL( CTextLayout& aTextLayout );
00278         void CreateRichTextPhoneNumberFormatterL( CTextLayout& aTextLayout, const CRichText& aText );
00287         CAknInlineTextSource* InlineTextSource() const;
CAknPictographInterface* PictographInterface() const;
00299         void SetSuppressBackgroundDrawing( TBool aSuppress );
00304         TBool IsBackgroundDrawingSuppressed() const;
00311         TInt ClearDirection() const;
00313     public: // from MCenRepNotifyHandlerCallback
00314         void HandleNotifyInt(TUint32 aId, TInt aNewValue);
00316     private:
CEikEdwinExtension();
00319         void ConstructL(CEikEdwin* aEdwin);
00321     private:
00323         enum TFlagIndices
00324             {
00325             ESkinBackgroundControlContextHasBeenSetIndex = 0,
00326             ESuppressBackgroundDrawing
00327             };
00328         class TAknEdwinPictographDrawer : public MAknPictographAnimatorCallBack
00329             {
00330             private: // From MAknPictographAnimatorCallBack
00331                 void DrawPictographArea();
00332             };        
00334         private:
00336                 CIdle* iSetScrollBar;
TAvkonEditorCustomWrap iTextWrapper;
00338                 CAknEdwinFormAccessor* iFormAccessor;
00339         CFormCursorModifier* iFormCursorModifier;
MAknsControlContext* iSkinBackgroundControlContext;
00341         TBitFlags iFlags;
00342         TInt iAlignment;
00343         TCallBack iPictoCallBack;       
00344         CAknEdwinFormExtendedInterfaceProvider* iFormExtendedInterfaceProvider; // Owned
00345         CAknInlineTextSource* iPhoneNumberFormatter;                 // Not owned
00346         CAknNoMatchesIndicatorInlineTextSource* iNoMatchesIndicatorFormatter;   // Not owned
00347         TAknEdwinPictographDrawer iPictographDrawer;
CAknPictographInterface* iPictographInterface;
00349         // For clear direction.
00350         CRepository* iCenRep;                           // Owned
CCenRepNotifyHandler* iCenRepNotifyHandler;     // Owned
00352         TInt iClearDirection;                           // Value of ClearDirection
00353      public:
00355         TInt iSkinIdForText;
TAknsHighlightStyle iSkinHighlightStyle;
SAknRgb iEditorBackgroundColor;
00358         TInt iUpperFullFormattingLength;
00359         CAknExtendedInputCapabilities* iExtendedInputCapabilities;
00360         TRect iTextLinesRect;
00361         TRect iScrollRect;
00362         TInt iTempCursorPos;
00363         TInt iTempAnchorPos;
00364         TInt iTempSelect;
CAknPointerEventSuppressor* iPtSuppressor;
00366         TBool iDragging;
00367         TInt iRecordCursor;
00368         TBool iRecordScroll;
00374         TBool* iDestroyedPtr;
00375         enum TDrawState
00376             {
00377             ENotDraw = 0,
00378             EDrawn,
00379             EDrawing
00380             };
00381         TInt iDrawInvoked;
00382         TInt iThumbPos;        
00383                 };
00385 public:
00395     enum TFlags
00396         { // user flags
00398         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,
EAvkonDisableVKB = 0x40000000
00546         };
00551     enum TClipboardFunc
00552                 {
ENoClipboard,
ECut,
ECopy,
EPaste
00564                 };
00570         enum TFindFlags
00571                 {
EFindDirectionUp        =0x01,
EFindWholeWord          =0x02,
EFindCaseSensitive      =0x04,
EFindAgain                      =0x08,
ENoBusyMessage          =0x10,
EReadOnlyFile           =0x20 // New for CKon
00589                 };
00596         enum TSetContent
00597                 {
EUseText,
ECopyText
00603                 };
00611         enum TOwnershipType
00612                 {
EOwnsText,
EDoesNotOwnText
00618                 };
00620     // order of hotkeys defined in resource file.  Not all applicable to plain 
00621     // text editors
00628         enum TEdwinHotKeys 
00629                 {
EHotKeyCut,
EHotKeyCopy,
EHotKeyPaste,
EHotKeyUndo,
EHotKeyFind,
EHotKeyInsertChar,
EHotKeyBold,
EHotKeyItalic,
EHotKeyUnderline,
EHotKeyFont,
EHotKeyInsertObject,
EHotKeyEditObject,
EHotKeyFormatObject
00668                 };
00670 public: // construction and destruction
00678     IMPORT_C ~CEikEdwin();
00686         IMPORT_C CEikEdwin();
00697         IMPORT_C CEikEdwin(const TGulBorder& aBorder);
00713         IMPORT_C void ConstructL(TInt aEdwinFlags=0,
00714                              TInt aWidthInChars=0,
00715                              TInt aTextLimit=0,
00716                              TInt aNumberOfLines=0);
00724     IMPORT_C void SetEdwinObserver(MEikEdwinObserver* aEdwinObserver);
00733     IMPORT_C void AddEdwinObserverL(MEikEdwinObserver* aEdwinObserver);
00741     IMPORT_C void RemoveEdwinObserver(MEikEdwinObserver* aEdwinObserver);
00746     IMPORT_C void SetContainerWindowL();
00757     IMPORT_C void SetDocumentContentL(CGlobalText& aText,
TSetContent aContent=CEikEdwin::ECopyText);
00760 public: // from CCoeControl
00772     IMPORT_C TKeyResponse OfferKeyEventL(const TKeyEvent& aKeyEvent,
00773                                          TEventCode aType);
00782     IMPORT_C void FocusChanged(TDrawNow aDrawNow);
00791     IMPORT_C void ActivateL();
00801     IMPORT_C void ConstructFromResourceL(TResourceReader& aReader);
00810     IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent);
00820     IMPORT_C TSize MinimumSize();
00829     IMPORT_C void Draw(const TRect& aRect) const;
00838     IMPORT_C void SetDimmed(TBool aDimmed);
00849     IMPORT_C void SetContainerWindowL(const CCoeControl& aParent);
00860     IMPORT_C virtual void GetColorUseListL(CArrayFix<TCoeColorUse>& 
00861                      aColorUseList) const; // not available before Release 005u
00863     // not available before Release 005u    
00872     IMPORT_C virtual void HandleResourceChange(TInt aType);
00887     IMPORT_C TCoeInputCapabilities InputCapabilities() const;
00899     IMPORT_C void SetInputCapabilitiesL(const TCoeInputCapabilities& 
00900                                         aInputCapabilities); 
00910     IMPORT_C void WriteInternalStateL(RWriteStream& aWriteStream) const;
00912 private:
00917     IMPORT_C void* ExtensionInterface( TUid aInterface );
00919 public: // from MEikScrollBarObserver
00929         IMPORT_C void HandleScrollEventL(CEikScrollBar* aScrollBar, 
TEikScrollEvent aEventType); 
00932 public: // from CTextView::MObserver
00942     IMPORT_C void OnReformatL(const CTextView* aTextView);
00944 public:
00951         IMPORT_C TInt TextLength() const;
00958         IMPORT_C TInt CursorPos() const;
00966         IMPORT_C TInt SelectionLength() const;
00974         IMPORT_C TCursorSelection Selection() const;
00980         IMPORT_C void ClearSelectionL();
00990         IMPORT_C void SetSelectionL(TInt aCursorPos,TInt aAnchorPos);
01002         IMPORT_C void SetCursorPosL(TInt aCursorPos,TBool aSelect);
01007         IMPORT_C void SelectAllL();
01021         IMPORT_C void CalculateWidth(TInt aWidthInChars);
01030         IMPORT_C void GetText(TDes& aDes) const;
01037     IMPORT_C HBufC* GetTextInHBufL() const;
01046         IMPORT_C void SetTextL(const TDesC* aDes);
01054         IMPORT_C void ClipboardL(TClipboardFunc aClipboardFunc);
01063         IMPORT_C void InsertFieldL(CTextField* aField, TUid aFieldType);
01068         IMPORT_C void UpdateAllFieldsL();
01077     IMPORT_C void UpdateCurrentFieldL();
01084     IMPORT_C TInt CountWords();
01094     IMPORT_C void InsertFromTextFileL(const TFileName &aFileName,
01095                     const CPlainText::TTextOrganisation 
01096                     aTextOrganisation=CPlainText::EOrganiseByLine);
01104     IMPORT_C static TInt IdleL(TAny *aPtr);
01112     IMPORT_C CPlainText* Text() const;
01114     // this is particularly important for when the front-end processor is 
01115     // inline-editing a CEikEdwin
01129     IMPORT_C void CancelFepTransaction(); 
01136     IMPORT_C void HandleTextChangedL();
01145     IMPORT_C TInt LayoutWidth() const;
01150         IMPORT_C void NotifyNewDocumentL();
01155         IMPORT_C void NotifyNewFormatL();
01166     IMPORT_C TBool FindL(const TDesC* aFindText,TInt aFindFlags=0);
01180     IMPORT_C TInt FindTextL(const TDesC* aFindText,TInt aPos,TInt aFindFlags);
01187     IMPORT_C void ReplaceL(SEdwinFindModel* aFindModel);
01197         IMPORT_C void ReplaceAllL(SEdwinFindModel* aFindModel);
01206         IMPORT_C void GetFindText(TDes* aFindText);
01211         IMPORT_C void UpdateScrollBarsL();
01219         IMPORT_C CEikScrollBarFrame* CreateScrollBarFrameL();
01226         inline CEikScrollBarFrame* CreatePreAllocatedScrollBarFrameL();
01233         inline CEikScrollBarFrame* ScrollBarFrame();
01241         IMPORT_C void SetWordWrapL(TBool aWrapIsOn);
01248     IMPORT_C virtual TInt LineCursorWidth() const;
01255     IMPORT_C void SetZoomFactorL(TZoomFactor* aZoomFactor);
01262     IMPORT_C void SetBackgroundColorL(TRgb aBackground);
01270     IMPORT_C void SetWysiwygModeOn(TInt aLayoutWidth,
01271                                    MGraphicsDeviceMap* aDevice);
01277     IMPORT_C void SetWysiwygModeOff();
01285     IMPORT_C void UpdateLayoutWidth(TInt aLayoutWidth); 
01290     IMPORT_C void SendDataOverIrL();
01297     IMPORT_C void ReceiveDataOverIrL();
01315         IMPORT_C void SetAmountToFormatL(TBool aIsNewDoc=EFalse);
01339     IMPORT_C void SetAmountToFormatL( TBool aIsNewDoc, TBool aReFormat );
01347     IMPORT_C void SetPasteFromIrStore(TBool aPasteFromIrStore);
01357     IMPORT_C void PasteFromStoreL(CStreamStore& aStore, 
01358                                   CStreamDictionary& aDict);
01366     IMPORT_C void CopyToStoreL(CStreamStore& aStore, CStreamDictionary& aDict);
01373     IMPORT_C void SetBorderViewMargins(TMargins8 aMargins);
01378     IMPORT_C void ForceScrollBarUpdateL();
01389     IMPORT_C void SetDocumentOwnership(TOwnershipType aOwner);
01397     IMPORT_C void SetTextLimit(TInt aLimit);
01404     IMPORT_C void RunCharMapDialogL();
01411     IMPORT_C TMargins8 Margins() const;
01422     IMPORT_C TInt UpperFullFormattingLength() const;
01437     IMPORT_C TInt LowerPartialFormattingLength() const;
01446     IMPORT_C void SetReadOnly(TBool aReadOnly);
01454     IMPORT_C TBool IsReadOnly() const;
01461     IMPORT_C void CheckNotReadOnlyL();
01469     IMPORT_C void SetAllowPictures(TBool aAllow);
01479     IMPORT_C void CheckRemovePictures(TInt aStartPos,TInt aLength);
01488     IMPORT_C void SetRightWrapGutter(TInt aGap);
01494     IMPORT_C void UndoL();
01499     IMPORT_C void ClearUndo();
01507     IMPORT_C void SetAllowUndo(TBool aAllow);
01515     IMPORT_C TBool SupportsUndo() const;
01524     IMPORT_C TBool CanUndo() const;
01535     IMPORT_C void SetWordDelimiters(TBool aPicture,TBool aPunctuation);
01545     IMPORT_C void GetWordInfo(TInt aCurrentPos,
01546                               TInt& aStartPos,
01547                               TInt& aLength) const;
01558     IMPORT_C void MoveCursorL(TCursorPosition::TMovementType aMovement,
01559                               TBool aSelect);
01567     IMPORT_C void MoveDisplayL(TCursorPosition::TMovementType aMovement);
01578     IMPORT_C void CheckValidityOfChars(TInt aStartPos,TInt aLength);
01586     IMPORT_C void SetOnlyASCIIChars(TBool aASCIIOnly);
01593     IMPORT_C TBool OnlyASCIIChars() const;
01600     inline TInt AvgLinesInViewRect() const;
01607     inline TInt AvgCharsPerLine() const;
01614     inline void SetAvgLinesInViewRect(TInt aAvgLines);
01621     inline void SetAvgCharsPerLine(TInt aAvgChars);
01628     IMPORT_C void SetEdwinSizeObserver(MEikEdwinSizeObserver* 
01629                                             aEdwinSizeObserver);
01636     IMPORT_C TInt MinimumHeight() const;
01647         IMPORT_C TInt MaximumHeight() const;
01653         IMPORT_C void SetMinimumHeight(TInt aHeight);
01665         IMPORT_C void SetMaximumHeight(TInt aHeight);
01667 public: // new utility methods
01677         IMPORT_C void InsertDeleteCharsL(TInt aInsertPos,
01678                                      const TDesC& aText,
01679                                      const TCursorSelection& aDelete);
01686     IMPORT_C void SetNonPrintingCharsVisibility(TNonPrintingCharVisibility 
01687                                                 aVisibility);
01694     IMPORT_C TNonPrintingCharVisibility NonPrintingCharsVisibility() const;
01696 public: // new Avkon wrap interface
01703         IMPORT_C void SetAvkonWrap(TBool aAvkonWrapIsOn);
01705 public: // Avkon editor extensions
01716     IMPORT_C void SetAknEditorCase(TInt aCase);
01727     IMPORT_C void SetAknEditorPermittedCaseModes(TInt aPermittedCaseModes);
01743     IMPORT_C void SetAknEditorNumericKeymap(TAknEditorNumericKeymap 
01744                                             aNumericKeymap);
01754     IMPORT_C void SetAknEditorInputMode(TInt aInputMode);
01763     IMPORT_C void SetAknEditorAllowedInputModes(TInt aInputModes);
01770     IMPORT_C void SetAknEditorSpecialCharacterTable(TInt aSCTResId);
01779     IMPORT_C void SetAknEditorFlags(TInt aFlags);
01787     IMPORT_C void EnableCcpuSupportL(TBool aSupport);
01799     IMPORT_C void SetAknEditorCurrentInputMode(TInt aInputMode);
01807     IMPORT_C TInt AknEditorCurrentInputMode();
01819     IMPORT_C void SetAknEditorCurrentCase(TInt aCase);
01828     IMPORT_C void SetAknEditorLocalLanguage(TLanguage aLanguage);
01834     IMPORT_C void NotifyEditorStateObserverOfStateChangeL();
01846     IMPORT_C void SetSuppressBackgroundDrawing( TBool aSuppress );
01853     IMPORT_C TBool IsBackgroundDrawingSuppressed() const;
01862     IMPORT_C void SetTextLinesRect( const TRect& aRect );
01867         IMPORT_C void SetScrollRect( const TRect & aRect );
01876     IMPORT_C TRect GetTextLinesRect() const;
01881     IMPORT_C void SetCursorVisible(TBool aVisible);
01882 public:
01884     // These methods have been added for use with Avkon to set maximum 
01885     // editor heights.
01891         IMPORT_C void SetMaximumHeightInLines(TInt aLines);
01898         IMPORT_C TInt MaximumHeightInLines() const;
01900 public: // From MEikCcpuEditor
01907         IMPORT_C TBool CcpuIsFocused() const;
01914         IMPORT_C TBool CcpuCanCut() const;
01919         IMPORT_C void CcpuCutL();
01926     IMPORT_C TBool CcpuCanCopy() const;
01931         IMPORT_C void CcpuCopyL();
01938     IMPORT_C TBool CcpuCanPaste() const;
01943         IMPORT_C void CcpuPasteL();
01950     IMPORT_C TBool CcpuCanUndo() const;
01956         IMPORT_C void CcpuUndoL();
01963     IMPORT_C TInt AknEdwinFlags() const;
01966 public: // Internal to Symbian
01968     // the following methods are deprecated and will be removed in a future 
01969     // release
01973         IMPORT_C void CreateTextViewL();
01980         IMPORT_C CTextView* TextView() const;
01987         IMPORT_C CTextLayout* TextLayout() const;
01995         IMPORT_C TBool SetUndoBufferL(const TCursorSelection& aSelection);
02002     IMPORT_C void SetUndoableText(const TCursorSelection& aSelection);
CAknEdwinState* EditorState() const;
02016         inline void SetMaxLength(TInt aLength);
02023         inline TInt MaxLength() const;
02025 public:
02027         // added to get access to user flags without a get/set for every different
02028     // flag.
02035         IMPORT_C void AddFlagToUserFlags(TUint32 aFlag);
02043     IMPORT_C void RemoveFlagFromUserFlags(TUint32 aFlag);
02051         IMPORT_C TUint32 UserFlags() const ;
02053 public:
02061         IMPORT_C void SetCharFormatLayer(CCharFormatLayer* aCharFormatLayer);
02069     IMPORT_C void SetParaFormatLayer(CParaFormatLayer* aParaFormatLayer);
02072 public: // Skins support
02089     IMPORT_C void SetSkinBackgroundControlContextL( MAknsControlContext* 
02090                                                     aContext );
MAknsControlContext* SkinBackgroundControlContext() const;
02117     TBool SkinEnabled() const;
02129         IMPORT_C void SetAlignment(TInt aAlignment);
02131 public: // Pictograph support
02136     void DrawTextView() const;
02146     IMPORT_C void SetPictographAnimationCallBack( TCallBack& aCallBack );
02154     const TCallBack& PictographAnimationCallBack() const;
02184     IMPORT_C void SetUpperFullFormattingLength( TInt aUpperFullFormattingLimit );
02193         IMPORT_C void SetSuppressNotifyDraw( TBool aEnabled );    
02205     IMPORT_C void SetSuppressFormatting( TBool aSuppressed );
02207 protected:
02212         enum TEnd
02213                 {
EStart,
EEnd   
02219                 };
02224         enum TChunkSize
02225                 {
EChunkWord,
EChunkPara
02231                 };
02236         enum TEikEdwinFlags // Internal flags
02237                 { 
ERichText           =0x00000001,
EDragDouble                     =0x00000002,
ELeftDownInViewRect =0x00000004,
ENumericCharacters      =0x00000008, 
EHasOneLineOnly     =0x00000010,  
EPhoneNumberGrouping = 0x00000020,
ESuppressNotifyDraw  = 0x00000040,
ESuppressFormatting  = 0x00000080 // Suppresses calls to formatting
02263         };
02265 protected: // from MEditObserver
02279         IMPORT_C void EditObserver(TInt aStartEdit,TInt aEditLength);
02281 protected:
02290         IMPORT_C void TrappedDraw(const TRect& aRect) const;
02295         IMPORT_C void DrawContents();
02306     IMPORT_C void BaseConstructL();
02313     IMPORT_C void FormatTextL();
02328     IMPORT_C TInt DeleteHighlightL(TBool& aChanged, 
02329                                    TBool aIsBackSpace=EFalse,
02330                                    TBool aPromptConfirmation=ETrue);
02344     IMPORT_C TBool OkToDeleteSelectionL();
02360     IMPORT_C void DeleteL(TBool& aChanged,
02361                           const TCursorSelection& aSelection,
02362                           TBool aIsBackSpace=EFalse,
02363                           TBool aAllowUndo=ETrue);
02369     IMPORT_C void TrappedSizeChanged();
02376     IMPORT_C void HandleSizeChangedL();
02386     IMPORT_C void CancelSelectionL(TEnd aEndOfSelectionToLeaveCursor);
02399     IMPORT_C void MoveCursorToChunkStartL(TBool aSelect,
TChunkSize aChunkSize,
TEnd aEndScanningTowards);
02407     IMPORT_C void CancelInsertCharFormat();
02412     IMPORT_C void PlaceDataOnClipboardL();
02425     IMPORT_C void ReportEdwinEventL(MEikEdwinObserver::TEdwinEvent aEventType);
02430     IMPORT_C void SetLineCursorDetailsL();
02438     IMPORT_C virtual void CopyDocumentContentL(CGlobalText& aInText,
02439                                                CGlobalText& aOutText);
02448     IMPORT_C void DisplayFindTextNotFound(TDes& aFindText);
02456     IMPORT_C virtual void HandleTextPastedL(TInt aStartPos,TInt& aLength);
02463     IMPORT_C virtual CLafEdwinCustomDrawBase* CreateCustomDrawL();
02465     // Avkon editor extensions
02471     IMPORT_C void ReadAknResourceL(TResourceReader& aReader);
02473 protected: // Internal to Symbian
02481         IMPORT_C void CreateLayoutL(MLayDoc* aLayDoc);
02491     IMPORT_C void CreateTextAndLayoutL(CParaFormatLayer* aParaFormatLayer,
02492                                        CCharFormatLayer* aCharFormatLayer);
02499     IMPORT_C void CheckEdwinExtensionL();
02506     IMPORT_C CEikEdwinExtension* EdwinExtension();
02508 private:
02510         enum
02511                 { // internal flags
02512                 EWysiwygOn                                              =0x00000010,
02513                 EUnderOneScreenFormattedText    =0x00000020,
02514                 EPictureDelimits                                =0x00000040,
02515                 EPunctuationDelimits                    =0x00000080,
02516                 EPasteFromIrStore                               =0x00000100,
02517                 ELockScrollBarState                             =0x00000200,
02518                 EOnReformatting                                 =0x00000400
02519                 };
02521 private: // from CCoeControl
02523         IMPORT_C void SizeChanged();
02524         IMPORT_C TInt CountComponentControls() const;
02525         IMPORT_C CCoeControl* ComponentControl(TInt aIndex) const;
02526         IMPORT_C void Reserved_2();
02528 private:
02530         IMPORT_C virtual void Reserved_3();
02531         IMPORT_C virtual void NotifyInvalidOperationOnReadOnlyL();
02532         IMPORT_C CEikScrollBarFrame* CreateScrollBarFrameL(TBool aPreAlloc);
02533         void SetVirtualCursorStateL(TBool aIsFocused) const;
02534         void SetHeightForNumOfLinesL();
02535         void ApplyAutoSelectionL();
02536         void SetScrollBarsL();
02537         void SetVertScrollBarModelByCharactersL(TEikScrollBarModel& aVertModel) const;
02538         void RetrieveDataFromClipboardL();
02539         void SetCursorVisibilityL(TBool aEmphasis);
02540         TBool OwnsScrollBars() const;
02541         void CreateScrollBarFrameLayout(TEikScrollBarFrameLayout& aLayout) const;
02542         void UpdateHorizScrollBarThumb();
02543         void UpdateVertScrollBarThumbL();
02544         void DoSetUndoBufferL(const TCursorSelection& aSelection);
02545         void DoPasteFromStoreL(const CStreamStore& aStore,const CStreamDictionary& aDict);
02546         void DoReplaceAllL(SEdwinFindModel* aModel,TBool& aTextFound,TBool& aReplaced);
02547         void DeleteExtraParasL(TInt aStartPos,TInt aLength);
02548         TInt LocateChar(TChar aChar,TInt aStartPos,TInt aLength);
02549         TBool IsValidChar(TInt aChar) const;
02550         TInt CalcMinimumHeightFromNumOfLinesL() const;
02551         void CheckEdwinHeight();
02552         TBool IsNewHeightWithinMinimumAndMaximum(TInt aNewHeight) const;
02553         void SetEdwinHeight(TInt aHeight);
02554         void DoCreateCustomDrawL();
02555         void SetCursorSizeAndType();
02556         TKeyResponse DoOfferKeyEventL(const TKeyEvent& aKeyEvent,TEventCode aType);
02557         void DoCcpuCanPasteL() const;
02558         void DoReportEventL(MCoeControlObserver::TCoeEvent aEvent);
02559         void CheckIfEdwinIsResizable();
02560         void SetKeyboardRepeatRate(TTimeIntervalMicroSeconds32 aKeyRepeatRate) const;
02561         HBufC* GetAllowedCharsLC() const;
02562         TInt CheckAllowedCharsL(const TDesC& aChars, CClipboard& aClipboard, TBool aRichText) const;
02564         TInt CursorWidth() const;
02565         TFontSpec CursorFontSpec() const;
02567         void BuildEdwinFepSupport();
02568         void MakeCharFormatLayerMatchL(CCharFormatLayer* aCharFormatLayer);
02569         void MakeParaFormatLayerMatchL(CParaFormatLayer* aParaFormatLayer);
02570     void UpdateCache(TInt aId);
02571         void DrawBackgroundAroundTextView( 
02572                 CWindowGc& gc, 
02573                 const TRect& aOuterRect, 
02574                 const TRect& aInnerRect, 
02575                 const TRgb& aBackgroundColor  ) const;
02576         TInt CurrentAlignment() const;
02577         void DoAlignment();
02578         void NewParagraphL();
02579     TKeyResponse ScrollReadOnlyNoCursorDisplayL(TUint aKeyCode);
02580     void ReplaceParaDelimitersL( TInt aStartPos, TInt aLength );
02581     TRect AdjustedViewRect() const;
02582     void SetVKBStatus();
02583     void ScrollViewToCursorLineL();
02584     void PerformRecordedOperationL();
02585     void ScrollIfAtTopOrBottom();
02587 private:
02589         void DrawFirstLineTextL() const;
02590     CAknEdwinDrawingModifier* AknEdwinDrawingModifier();
02591     TBool EditorSupportsNeutralProtection() const;
02604     TBool NeedsNeutralProtection( TInt aPosOfLowEndOfDelete, TInt aLengthToDelete, TDes& aNewText, TBool& aForwardProtectionNeeded );
02614     TBool GetStrongDirectionality(TChar aChar, TBool& aRightToLeft ) const;
02622     TBool CharIsNeutral( TInt aPos ) const;
02638     TBool GetExposedDirectionOfTextInDescriptor( const TDesC& aText, TBool aForward, TBool& aIsRightToLeft ) const;
02652     TBool GetExposedDirectionOfText( TInt aPos, TBool aForward, TBool& aIsRightToLeft ) const;
02670     void ReplaceSelectionWithTextL( const TDesC& aNewText, 
02671                                     TInt aCursorPosInNewText,
02672                                     TBool& aFormatHasChanged );
02683     TBool IsPurePhoneNumberEditor() const;
02690     TBool NeedToChangeFormattingModeL() const;          
02696     void CalculateLineMetricsForBandFormattingL();
02698 protected:      // from MObjectProvider
02717         IMPORT_C TTypeUid::Ptr MopSupplyObject(TTypeUid aId);
02719 public: // new since 3.0
02726     IMPORT_C void SetTextSkinColorIdL(TInt aAknSkinIdForTextColor);
02733     IMPORT_C void SetHighlightStyleL(TAknsHighlightStyle aStyle);
02735     // for custom drawer, not exported
02741     TInt SkinColorId() const;
TAknsHighlightStyle HighlightStyle() const;
02770     TRgb EditorBackgroundColor(TRgb& aConditionalColor) const;
02772 protected:
02777         TUint32 iEdwinUserFlags;
02782         TUint32 iEdwinInternalFlags;
02787         CPlainText* iText;
02789 protected: // Internal to Symbian
02794         CTextView* iTextView;
02799         CTextLayout* iLayout;
02801 protected:
02806         TInt iTextLimit;
02811         TInt iNumberOfLines;
02816     MGraphicsDeviceMap* iZoomFactor;
02821     TInt iLastPointerDocPos;
02826     TMargins8 iMargins;
02828 private:
02830         friend class CEikEdwinFepSupport;
02831         friend class CEikEdwinExtension;
02832         // added this class to allow additional data members without breaking BC
CEikEdwinExtension* iEdwinExtension; // replaced iSetScrollBar
CEikScrollBarFrame* iSBFrame;
MEikEdwinObserver* iEdwinObserver;
02836         CArrayPtr<MEikEdwinObserver>* iObserverArray;
CEikEdwinFepSupport* iEdwinFepSupport;
02838         CUndoBuffer* iUndoStore;
02839         TInt iAvgLinesInViewRect;
02840         TInt iAvgCharsPerLine;
02841         TInt iRightWrapGutter;
02842         TInt iLayoutWidth;
MEikEdwinSizeObserver* iEdwinSizeObserver;
02844         TInt iMinimumHeight;
02845         TInt iMaximumHeight;
02846 /* 
02847 iMaximumHeightInLines
02848 ---------------------
02849 This is simply a holder for the number, used to simplify some Avkon LAF requirements.
02850 The viewable region of an edwin is actually measured in pixels, However, if certain LAF
02851 requirements are enforced (that the view region has to be smaller than the number of 
02852 lines viewable * the baseline separation (in pixels)) some undesired scrolling effects
02853 occur.
02854 
02855 
02856 That is to say, by simply setting iMaximumHeightInLines, this will not affect
02857 the actual maximum height of the edwin.  To do this, you must set the iMaximumHeight
02858 
02859 One of the use cases of this member variable is for AknLayoutUtils::LayoutEdwin. 
02860 That method uses iMaximumHeightInLines along with the baseline separation, to set 
02861 the iMaximumHeight.
02862 
02863 The general formula is very simple, to remove unneeded scrolling.
02864 iMaximumHeight=baselineSeparation*iMaximumNumberOfLines
02865 
02866 If you cannot allocate sufficient space to the edwin, to permit so much viewable region
02867 then the method AlterViewRect can be called on the TextView() component.  This will introduce
02868 a clipping rectangle, which allows blank space required by the edwin layout component
02869 to not be shown.
02870 */
02871         TInt iMaximumHeightInLines; 
02872         CLafEdwinCustomDrawBase* iCustomDrawer;
02873         TInt iLastPointerAnchorPos;
CAknCcpuSupport* iCcpuSupport;
02875         CCharFormatLayer* iCharFormatLayer;
02876         CParaFormatLayer* iParaFormatLayer;
02877         TInt iSpare_1;
02878         TInt iSpare_2;
02879         };
02882 inline CEikScrollBarFrame* CEikEdwin::CreatePreAllocatedScrollBarFrameL()
02883         { return CreateScrollBarFrameL(ETrue);}
02884 inline CEikScrollBarFrame* CEikEdwin::ScrollBarFrame()
02885         { return ((CEikScrollBarFrame* const)iSBFrame); }
02886 inline TInt CEikEdwin::AvgLinesInViewRect() const
02887         { return iAvgLinesInViewRect; }
02888 inline TInt CEikEdwin::AvgCharsPerLine() const
02889         { return iAvgCharsPerLine;}
02890 inline void CEikEdwin::SetAvgLinesInViewRect(TInt aAvgLines)
02891         { iAvgLinesInViewRect=aAvgLines; }
02892 inline void CEikEdwin::SetAvgCharsPerLine(TInt aAvgChars)
02893         { iAvgCharsPerLine=aAvgChars; }
02895 inline void CEikEdwin::SetMaxLength(TInt aLength ) 
02896         { SetTextLimit(aLength); }
02897 inline TInt CEikEdwin::MaxLength() const 
02898         { return iTextLimit; }
02900 #endif