EIKSECED.H

00001 // EIKSECED.H
00002 //
00003 // Copyright (c) 1997-1999 Symbian Ltd.  All rights reserved.
00004 //
00006 #if !defined(__EIKSECED_H__)
00007 #define __EIKSECED_H__
00008 
00009 #if !defined(__EIKDEF_H__)
00010 #include <eikdef.h>
00011 #endif
00012 
00013 #if !defined(__EIKBCTRL_H__)
00014 #include <eikbctrl.h>
00015 #endif
00016 
00017 #include <fepbase.h>
00019 // FORWARD DECLARATIONS
00020 class TResourceReader;
00021 class CEikSecretEditorExtension;
00022 class MAknsControlContext;
00035 class CEikSecretEditor : public CEikBorderedControl, public MCoeFepAwareTextEditor, public MCoeFepAwareTextEditor_Extension1
00036         {
00037 public:
00038     enum { 
EMaxSecEdBufLength = 32,
EMaxSecEdSecArrayLength = 255
00052         };
00059     enum TFeatureId
00060         {
EDisablePenInput
00065         };    
00068 public:
00079     IMPORT_C CEikSecretEditor();
00084     IMPORT_C ~CEikSecretEditor();
00086 public:    // from CCoeControl
00099     IMPORT_C virtual void ConstructFromResourceL(TResourceReader& aReader);
00108     IMPORT_C virtual TSize MinimumSize();
00119     IMPORT_C virtual TKeyResponse OfferKeyEventL(const TKeyEvent& aKeyEvent,TEventCode aType);
00128     IMPORT_C virtual void GetColorUseListL(CArrayFix<TCoeColorUse>& aColorUseList) const; // not available before Release 005u
00140     IMPORT_C virtual void HandleResourceChange(TInt aType);    // not available before Release 005u
00156     IMPORT_C virtual TCoeInputCapabilities InputCapabilities() const;
00165     IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent);
00167 public:    // specific
00179     IMPORT_C void GetText(TDes& aText) const;
00186     IMPORT_C virtual void SetText(const TDesC& aText);
00194     IMPORT_C virtual void InitializeDisplay(TInt aNumberOfChars);
00199     IMPORT_C void Reset();
00212     IMPORT_C void SetMaxLength(TInt aMaxLength);
00220     IMPORT_C void AknSetFont(const CFont &aFont);
00227     IMPORT_C void AknSetAlignment(const CGraphicsContext::TTextAlign &aAlign);
00240     IMPORT_C void SetDefaultInputMode(TInt aInputMode);
00247     IMPORT_C TInt MaxLength() const;
00254     IMPORT_C const TDesC& Buffer() const;
00261     IMPORT_C void RevealSecretText( TBool aReveal );
00274     IMPORT_C void EnableSCT( TBool aEnable = ETrue );
00287     IMPORT_C void SetSkinBackgroundControlContextL( MAknsControlContext* aContext );
00289 protected:    // inherited
00290     // methods to enable CAknNumericSecretEditor to inherit from CEikSecretEditor
00296     IMPORT_C virtual void AppendCharacterL( TInt aKeyCode );
00301     IMPORT_C virtual void Update();
00303     void InsertSecretChar();
00311     IMPORT_C void SizeChanged();
00313 private: // virtual
00314     IMPORT_C virtual void Draw(const TRect& aRect) const;
00316 private: // from MCoeFepAwareTextEditor
00317     IMPORT_C void StartFepInlineEditL(const TDesC& aInitialInlineText, TInt aPositionOfInsertionPointInInlineText, TBool aCursorVisibility, const MFormCustomDraw* aCustomDraw, MFepInlineTextFormatRetriever& aInlineTextFormatRetriever, MFepPointerEventHandlerDuringInlineEdit& aPointerEventHandlerDuringInlineEdit);
00318     IMPORT_C void UpdateFepInlineTextL(const TDesC& aNewInlineText, TInt aPositionOfInsertionPointInInlineText);
00319     IMPORT_C void SetInlineEditingCursorVisibilityL(TBool aCursorVisibility);
00320     IMPORT_C void CancelFepInlineEdit();
00321     IMPORT_C TInt DocumentLengthForFep() const;
00322     IMPORT_C TInt DocumentMaximumLengthForFep() const;
00323     IMPORT_C void SetCursorSelectionForFepL(const TCursorSelection& aCursorSelection);
00324     IMPORT_C void GetCursorSelectionForFep(TCursorSelection& aCursorSelection) const;
00325     IMPORT_C void GetEditorContentForFep(TDes& aEditorContent, TInt aDocumentPosition, TInt aLengthToRetrieve) const;
00326     IMPORT_C void GetFormatForFep(TCharFormat& aFormat, TInt aDocumentPosition) const;
00327     IMPORT_C void GetScreenCoordinatesForFepL(TPoint& aLeftSideOfBaseLine, TInt& aHeight, TInt& aAscent, TInt aDocumentPosition) const;
00328     IMPORT_C void DoCommitFepInlineEditL();
00329     IMPORT_C MCoeFepAwareTextEditor_Extension1* Extension1(TBool& aSetToTrue);
00330     IMPORT_C void SetStateTransferingOwnershipL(CState* aState, TUid aTypeSafetyUid);
00331     IMPORT_C CState* State(TUid aTypeSafetyUid); // this function does *not* transfer ownership
00333 private:
00334     void OverflowAlert();
00336 private: // from CCoeControl
00337     IMPORT_C void Reserved_1();
00338     IMPORT_C void Reserved_2();
00339 private:
00343     IMPORT_C void* ExtensionInterface( TUid aInterface );
00344 private: // from MCoeFepAwareTextEditor
00345     IMPORT_C void MCoeFepAwareTextEditor_Reserved_2();
00346 private:  // from MCoeFepAwareTextEditor_Extension1
00347     IMPORT_C virtual void MCoeFepAwareTextEditor_Extension1_Reserved_2();
00348     IMPORT_C virtual void MCoeFepAwareTextEditor_Extension1_Reserved_3();
00349     IMPORT_C virtual void MCoeFepAwareTextEditor_Extension1_Reserved_4();
00351 private: // specific
00352     void InsertChar();
00353     TInt CharsFitOnEditor() const;
00354     IMPORT_C virtual MCoeFepAwareTextEditor_Extension1::CState* CreateFepStateL();
00355     void CalculateAscent();
00356     void ReportUpdate();
00357 private:
00358     typedef TBuf<EMaxSecEdBufLength> TSecEdBuf;
00359 protected:
00360     HBufC* iSecCharArr;
00361     TInt iSecPos;
00362     TSecEdBuf iBuf;
00363     TInt iMaxLen;
00364     TInt iCharWidth;
00365     TInt iAscent;
00366     TBool iBufferFull;
00368 public: // timer methods
00369     void StartTimer();
00370 private:
00371     static TInt TimerCallback(TAny* aThis);
00372 private:
00373     CPeriodic* iTimer;
00374     const CFont *iFont;
00375     CGraphicsContext::TTextAlign iAlign;
00376     TBool iRevealSecretText; // holds the state of whether text is shown or not
00377     CEikSecretEditorExtension* iExtension;
00378     CState* iFepState;
00379     HBufC* iInlineEditText;
00381 public:
00389     IMPORT_C void SetSkinTextColorL(TInt aAknSkinIDForTextColor, TInt aAknSkinIdForBgColor=KErrNotFound);
00401     IMPORT_C TInt SetFeature( TInt aFeatureId, TInt aFeatureParam );
00414     IMPORT_C TInt GetFeature( TInt aFeatureId, TInt& aFeatureParam ) const;
00424     IMPORT_C TBool SupportsFeature( TInt aFeatureId ) const;    
00425     };
00427 #endif