1 /*

     2 * Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies). 

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  Container class for compose view

    15 *

    16 */

    17 

    18 

    19 #ifndef CNCSCOMPOSEVIEWCONTAINER_H

    20 #define CNCSCOMPOSEVIEWCONTAINER_H

    21 

    22 

    23 #include <AknDef.h>

    24 #include <AknsControlContext.h>

    25 #include <eikedwob.h>

    26 #include <aknphysicsobserveriface.h> // MAknPhysicsObserver

    27 

    28 #include "ncsfieldsizeobserver.h"

    29 #include "ncsconstants.h"

    30 #include "FreestyleEmailUiContactHandlerObserver.h"

    31 #include "FreestyleEmailUi.hrh"

    32 

    33 //<cmail>

    34 #include <aknlongtapdetector.h>

    35 //</cmail>

    36 

    37 class CAknPhysics;

    38 class CNcsEditor;

    39 class CNcsComposeView;

    40 class CNcsHeaderContainer;

    41 class CAknLongTapDetector;

    42 class CAknDoubleSpanScrollBar;

    43 class CFSMailBox;

    44 class CAknsLayeredBackgroundControlContext;

    45 class CFsAutoSaver;

    46 class CNcsEmailAddressObject;

    47 

    48 enum TAppendAddresses 

    49 	{

    50 	EAppendTo,

    51 	EAppendCc,

    52 	EAppendBcc

    53 	};

    54 

    55 

    56 /**

    57 *  CNcsComposeViewContainer container control class.

    58 */

    59 class CNcsComposeViewContainer: public CCoeControl, public MNcsFieldSizeObserver,

    60                                 public MEikScrollBarObserver,

    61                                 public MFSEmailUiContactHandlerObserver,

    62                                 public MAknLongTapDetectorCallBack,

    63                                 public MEikEdwinObserver,

    64                                 public MEikEdwinSizeObserver,

    65                                 public MAknPhysicsObserver

    66     {

    67     

    68 public:

    69  

    70     /** Initialisation flags. */

    71     enum TInitFlags

    72         {

    73         ECcFieldVisible  = 0x1,

    74         EBccFieldVisible = 0x2

    75         };

    76 

    77     /**

    78     * Two-phased constructor.

    79     * Create a CNcsComposeViewContainer object, which will draw itself to aRect

    80     * @param aView The parent view of this container.

    81     * @param aRect The rectangle this view will be drawn to.

    82     * @param aMailBox reference to current mailbox item.

    83     * @param aFlags Initilisation flags defined in @c TInitFlag enumeration.

    84     * @return a pointer to the created instance of CNcsComposeViewContainer.

    85     */

    86     static CNcsComposeViewContainer* NewL( CNcsComposeView& aView, 

    87         const TRect& aRect, CFSMailBox& aMailBox, CFsAutoSaver& aAutoSaver,

    88         TInt aFlags = NULL );

    89 

    90     /**

    91     * Destructor.

    92     */

    93     virtual ~CNcsComposeViewContainer();

    94 

    95 public: // new functions

    96         

    97     /**

    98     * UpdateScrollBarL

    99     * Updates scroll bar data.

   100     */

   101     void UpdateScrollBarL();

   102 

   103     /**

   104     * GetToFieldAddressesL

   105     * Get addresses in TO-field.

   106     * @return Array of address objects.

   107     */

   108     const RPointerArray<CNcsEmailAddressObject>& GetToFieldAddressesL( TBool aParseNow=ETrue );

   109 

   110     /**

   111     * GetCcFieldAddressesL

   112     * Get addresses in CC-field.

   113     * @return Array of address objects.

   114     */

   115     const RPointerArray<CNcsEmailAddressObject>& GetCcFieldAddressesL( TBool aParseNow=ETrue );

   116 

   117     /**

   118     * GetBccFieldAddressesL

   119     * Get addresses in BCC-field.

   120     * @return Array of address objects.

   121     */

   122     const RPointerArray<CNcsEmailAddressObject>& GetBccFieldAddressesL( TBool aParseNow=ETrue );

   123 

   124     /**

   125     * GetSubjectLC

   126     * Get text in subject field.

   127     * @return Descriptor containing subject field text.

   128     */

   129     HBufC* GetSubjectLC() const;

   130 

   131     /**

   132     * GetToFieldSelectionLength

   133     * Get the length of selected text in TO-field.

   134     * @return Selection length.

   135     */

   136     TInt GetToFieldSelectionLength() const;

   137 

   138     /**

   139     * GetCcFieldSelectionLength

   140     * Get the length of selected text in CC-field.

   141     * @return Selection length.

   142     */

   143     TInt GetCcFieldSelectionLength() const;

   144 

   145     /**

   146     * GetBccFieldSelectionLength

   147     * Get the length of selected text in BCC-field.

   148     * @return Selection length.

   149     */

   150     TInt GetBccFieldSelectionLength() const;

   151 

   152     /**

   153     * GetToFieldLength

   154     * Get TO-field text length.

   155     * @return Text length.

   156     */

   157     TInt GetToFieldLength() const;

   158 

   159     /**

   160     * GetCcFieldLength

   161     * Get CC-field text length.

   162     * @return Text length.

   163     */

   164     TInt GetCcFieldLength() const;

   165 

   166     /**

   167     * GetBccFieldLength

   168     * Get BCC-field text length.

   169     * @return Text length.

   170     */

   171     TInt GetBccFieldLength() const;

   172         

   173     /**

   174     * GetSubjectFieldLength

   175     * Get SUBJECT-field text length.

   176     * @return Text length.

   177     */

   178     TInt GetSubjectFieldLength() const;

   179 

   180     /**

   181     * GetMessageFieldLength

   182     * Get MESSAGE-field text length.

   183     * @return Text length.

   184     */

   185     TInt GetMessageFieldLength() const;

   186 

   187     /**

   188     * GetAttachmentCount

   189     * Get number of attachments.

   190     * @return Attachment count.

   191     */

   192     TInt GetAttachmentCount() const;

   193 

   194     /**

   195     * HasRemoteAttachments

   196     * Tells if the message has one or more remote attachments

   197     * @return ETrue if the message has at least one remote attachment.

   198     */

   199     TBool HasRemoteAttachments() const;

   200 

   201     /**

   202     * GetLookupTextLC

   203     * Get the text to match for fast addressing or remote lookup.

   204     * @return Match text.

   205     */

   206     HBufC* GetLookupTextLC() const;

   207 

   208     /**

   209     * SetToFieldAddressesL

   210     * Set TO-field addresses.

   211     * @param aAddress Array of address objects.

   212     */

   213     void SetToFieldAddressesL( RPointerArray<CNcsEmailAddressObject>& aAddress );

   214 

   215     /**

   216     * SetCcFieldAddressesL

   217     * Set CC-field addresses.

   218     * @param aAddress Array of address objects.

   219     */

   220     void SetCcFieldAddressesL( RPointerArray<CNcsEmailAddressObject>& aAddress );

   221 

   222     /**

   223     * SetBccFieldAddressesL

   224     * Set BCC-field addresses.

   225     * @param aAddress Array of address objects.

   226     */

   227     void SetBccFieldAddressesL( RPointerArray<CNcsEmailAddressObject>& aAddress );

   228 

   229     /**

   230     * AppendToFieldAddressesL

   231     * Append TO-field addresses.

   232     * @param aAddress Array of address objects.

   233     */

   234     void AppendToFieldAddressesL( RPointerArray<CNcsEmailAddressObject>& aAddress );

   235 

   236     /**

   237     * AppendCcFieldAddressesL

   238     * Append CC-field addresses.

   239     * @param aAddress Array of address objects.

   240     */

   241     void AppendCcFieldAddressesL( RPointerArray<CNcsEmailAddressObject>& aAddress );

   242 

   243     /**

   244     * AppendBccFieldAddressesL

   245     * Append BCC-field addresses.

   246     * @param aAddress Array of address objects.

   247     */

   248     void AppendBccFieldAddressesL( RPointerArray<CNcsEmailAddressObject>& aAddress );

   249 

   250     /**

   251     * SetSubjectL

   252     * Set SUBJECT-field text.

   253     * @param aSubject Text.

   254     */

   255     void SetSubjectL( const TDesC& aSubject );

   256 

   257     /**

   258     * SetCcFieldVisibleL

   259     * Set the visibility of CC-field.

   260     * @param aVisible True if the field is to be visible.

   261     * @param aFocus True if the field is to be focused.

   262     */

   263     void SetCcFieldVisibleL( TBool aVisible, TBool aFocus=ETrue );

   264 

   265     /**

   266     * SetBccFieldVisibleL

   267     * Set the visibility of BCC-field.

   268     * @param aVisible True if the field is to be visible.

   269     * @param aFocus True if the field is to be focused.

   270     */

   271     void SetBccFieldVisibleL( TBool aVisible, TBool aFocus=ETrue );

   272 

   273     /**

   274     * SetMenuBar

   275     * Set the menu bar.

   276     * @param aMenuBar The menu bar.

   277     */

   278     void SetMenuBar( CEikButtonGroupContainer* aMenuBar );

   279 

   280     /**

   281     * SetAttachmentLabelTextL

   282     * Set attachments label information.

   283     * @param aText The text to be shown in the attachments label.

   284     */

   285     void SetAttachmentLabelTextL( const TDesC& aText );

   286 

   287     /**

   288     * SetAttachmentLabelTextL

   289     * Set attachments label information from file name and size information.

   290     * Some decorations may be added. The file name will be truncated autoamtically if needed.

   291     * @param    aAttachmentName     The name of the attachment to be shown

   292     * @param    aAttachmentSizeDesc Descriptor containing size information about the file

   293     */

   294     void SetAttachmentLabelTextL( const TDesC& aAttachmentName, const TDesC& aAttachmentSizeDesc );

   295 

   296     void FixSemicolonL();

   297     

   298     void HideAttachmentLabel();

   299     /**

   300     * IsCcFieldVisible

   301     * Test if CC-field is visible.

   302     * @return True if visible.

   303     */

   304     TBool IsCcFieldVisible() const;

   305 

   306     /**

   307     * IsBccFieldVisible

   308     * Test if BCC-field is visible.

   309     * @return True if visible.

   310     */

   311     TBool IsBccFieldVisible() const;

   312 

   313 // <cmail> Removed unneeded IsFocusAif

   314 // </cmail>

   315 

   316     /**

   317     * IsFocusTo

   318     * Test if TO-field is focused.

   319     * @return True if focused.

   320     */

   321     TBool IsFocusTo() const;

   322 

   323     /**

   324     * IsFocusCc

   325     * Test if CC-field is focused.

   326     * @return True if focused.

   327     */

   328     TBool IsFocusCc() const;

   329 

   330     /**

   331     * IsFocusBcc

   332     * Test if BCC-field is focused.

   333     * @return True if focused.

   334     */

   335     TBool IsFocusBcc() const;

   336 

   337     /**

   338     * IsFocusAttachments

   339     * Test if ATTACHMENTS-field is focused.

   340     * @return True if focused.

   341     */

   342     TBool IsFocusAttachments() const;

   343         

   344     /**

   345     * IncludeAddressL

   346     */

   347     void IncludeAddressL();

   348 

   349     /**

   350     * IncludeAddressL

   351     */

   352     void IncludeAddressL(const CNcsEmailAddressObject& eml);

   353         

   354     /**

   355     * ClosePopupContactListL

   356     * Closes the popup listbox.

   357     */

   358     void ClosePopupContactListL();

   359 

   360     /**

   361     * DeleteSelectionL

   362     * Deletes selected text in focused AIF

   363     */

   364     void DeleteSelectionL();

   365 

   366     /**

   367      * Set the contents of the message body.

   368      * @param aMessage Contents of MESSAGE-field.

   369      * @parem aReadOnlyQuote Contents of read-only quote field.

   370      */

   371     void SetBodyContentL( const TDesC& aMessage, const TDesC& aReadOnlyQuote );

   372 

   373     /**

   374      * Get the contents of message body. The message body consists of

   375      * MESSAGE-field followed by optional read-only quote field.

   376      * @return Message body.

   377      */

   378     HBufC* GetBodyContentLC();

   379 

   380     /**

   381      * BodyText

   382      * Gets modifiable reference to the text in body text field.

   383      */

   384     CRichText& BodyText();

   385 

   386     /**

   387     * SetApplicationRect

   388     * Sets the container rectangle.

   389     * @param aRect The rectangle.

   390     */

   391 	// <cmail>

   392     // void SetApplicationRect( TRect aRect );

   393 	// </cmail>

   394 

   395     /**

   396     * SetFocusToToField

   397     * Focuses the TO-field.

   398     */

   399     void SetFocusToToField();

   400 

   401     /**

   402     * SetFocusToAttachmentField

   403     * Focuses the ATTACHEMENT-field.

   404     */

   405     void SetFocusToAttachmentField();

   406         

   407     /**

   408     * SetFocusToMessageFieldL

   409     * Focuses the MESSAGE-field.

   410     */

   411     void SetFocusToMessageFieldL();

   412 

   413     /**

   414     * AddQuickTextL

   415     * Inserts text in current cursor position.

   416     * @param aText Text to insert.

   417     */

   418     void AddQuickTextL( const TDesC& aText );

   419         

   420     /**

   421     * SelectAllToFieldTextL

   422     * Selects all TO-field text.

   423     */

   424     void SelectAllToFieldTextL();

   425 

   426     /**

   427     * SelectAllCcFieldTextL

   428     * Selects all CC-field text.

   429     */

   430     void SelectAllCcFieldTextL();

   431 

   432     /**

   433     * SelectAllBccFieldTextL

   434     * Selects all BCC-field text.

   435     */

   436     void SelectAllBccFieldTextL();

   437 

   438     /**

   439     * SelectAllSubjectFieldTextL

   440     * Selects all SUBJECT-field text.

   441     */

   442     void SelectAllSubjectFieldTextL();

   443 			

   444     /**

   445     * IsSubjectFieldEmpty

   446     * Tells if SUBJECT-field is empty (has default text or is empty).

   447     * @return True if user has not put anything to the field.

   448     */

   449     TBool IsSubjectFieldEmpty();

   450 		

   451     /**

   452     * AppendAddressesL

   453     * Displays contacts dialog and appends selected addresses in 

   454     * focused AIF.

   455     *

   456     * @return ETrue if addresses we tried to append, EFalse otherwise. 

   457     */

   458     TBool AppendAddressesL();

   459 		

   460     /**

   461     * HandleAttachmentsOpenCommand

   462     * 

   463     */

   464     void HandleAttachmentsOpenCommandL();

   465 		

   466     /**

   467     * LaunchAttachmentActionMenuL

   468     * 

   469     */

   470     void LaunchAttachmentActionMenuL();

   471     

   472     /**

   473     * AreAddressFieldsEmpty

   474     * 

   475     */

   476     TBool AreAddressFieldsEmpty();

   477 		

   478     void DoPopupSelectL();

   479 		

   480     void HandleLayoutChangeL();

   481     

   482     void HandleSkinChangeL();

   483     

   484     TInt ContentTotalHeight();

   485     /**

   486     * CommitL

   487     * Commits changes to message

   488     */

   489     void CommitL( TFieldToCommit aFieldToCommit = EAllFields );

   490 

   491     //<cmail>

   492     //sets up iSwitchChangeMskOff falg, which disables changes of MSK label if any popup dialog is open

   493     void SwitchChangeMskOff(TBool aTag);

   494     //</cmail>

   495     

   496     /**

   497      * ScrollL

   498      * @param aTargetPos Scrolls display to given position

   499      */

   500     void ScrollL( TInt aTargetPos );

   501     

   502 public: // from CoeControl

   503 

   504         /**

   505         * Draw

   506         * Draw this CNcsComposeViewContainer to the screen.

   507         * @param aRect the rectangle of this view that needs updating

   508         */

   509     void Draw( const TRect& aRect ) const;

   510     

   511     void SetMskL();

   512     

   513 	//<cmail>

   514     /**

   515     * Handle pointer event

   516     * 

   517     */

   518     void HandlePointerEventL( const TPointerEvent& aPointerEvent );

   519     //</cmail>

   520 	

   521     /**

   522     * OfferKeyEventL

   523     * Key event handler.

   524     * @param aKeyEvent The key event.

   525     * @param aType The type of key event.

   526     * @return Indicates whether the key event was used by this control.

   527     */

   528     TKeyResponse OfferKeyEventL( const TKeyEvent& aKeyEvent, TEventCode aType );

   529         

   530     /**

   531     * SizeChanged

   532     * Responds to changes to the size and position of the contents of this control.

   533     */

   534     void SizeChanged();

   535         

   536     /**

   537     * Responds to a change in focus.

   538     * @param aDrawNow Contains the value that was passed to SetFocus.

   539     */

   540     void FocusChanged(TDrawNow aDrawNow);

   541         

   542     /**

   543     * MopSupplyObject

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

   545     * @param aId An encapsulated object type ID.

   546     */

   547     TTypeUid::Ptr MopSupplyObject( TTypeUid aId );

   548     

   549 	/**

   550     * Informs if Remotesearch is in progress

   551     */

   552     TBool IsRemoteSearchInprogress() const;

   553     

   554 public: // from MEikScrollBarObserver

   555     

   556         /**

   557         * HandleScrollEventL

   558         */

   559     void HandleScrollEventL( CEikScrollBar* aScrollBar, TEikScrollEvent aEventType );

   560 

   561 public: // from MFSEmailUiContactHandlerObserver

   562 

   563     void OperationCompleteL( TContactHandlerCmd aCmd,

   564         const RPointerArray<CFSEmailUiClsItem>& aContacts );

   565     void OperationErrorL( TContactHandlerCmd aCmd, TInt aError );

   566 

   567 public: // from base class MEikEdwinObserver

   568 

   569     void HandleEdwinEventL( CEikEdwin* aEdwin, TEdwinEvent aEventType );

   570 

   571 public: // from base class MEikEdwinSizeObserver

   572     

   573     TBool HandleEdwinSizeEventL( CEikEdwin* aEdwin, TEdwinSizeEvent aEventType, TSize aDesirableEdwinSize );

   574     

   575 public:  // from MNcsFieldSizeObserver

   576 

   577     TBool UpdateFieldSizeL();

   578     void UpdateFieldPosition( CCoeControl* aAnchor );

   579 

   580     //<cmail>

   581 private:  //From MAknLongTapDetectorCallBack

   582     void HandleLongTapEventL( const TPoint& aPenEventLocation, const TPoint& aPenEventScreenLocation );

   583     //</cmail>

   584     

   585 private:

   586     

   587     /**

   588     * Constructor

   589     * @param aView The parent view

   590     */

   591     CNcsComposeViewContainer( CNcsComposeView& aView, CFsAutoSaver& aAutoSaver,

   592         CFSMailBox& aMailBox );

   593 

   594     /**

   595     * ConstructL

   596     * 2nd phase constructor

   597     * @param aRect Rectangle where container is drawn to.

   598     */

   599     void ConstructL( const TRect& aRect, TInt aFlags );

   600         

   601     /**

   602     * ChangeFocusL

   603     * Changes focus according to key event and focused control.

   604     * @param aKeyEvent The key event.

   605     * @return Indicates whether the key event was used by this control.

   606     */

   607     TKeyResponse ChangeFocusL( const TKeyEvent& aKeyEvent );

   608         

   609     /**

   610     * UpdateScreenPositionL

   611     * @param aKeyCode Needed to recognize presses of the enter key

   612     *                 in moving of display.

   613     */

   614     void UpdateScreenPositionL( const TUint& aKeyCode = EKeyNull );

   615     //<cmail>

   616     TRgb CalculateSeparatorLineSecondaryColor();

   617     //</cmail>

   618     void UpdatePhysicsL();

   619 

   620 private: // from MAknPhysicsObserver

   621 

   622    /**

   623     * @see MAknPhysicsObserver::ViewPositionChanged

   624     */

   625    virtual void ViewPositionChanged( const TPoint& aNewPosition, TBool aDrawNow, TUint aFlags );

   626 

   627    /**

   628     * @see MAknPhysicsObserver::PhysicEmulationEnded

   629     */

   630    virtual void PhysicEmulationEnded();

   631 

   632    /**

   633     * @see MAknPhysicsObserver::ViewPosition

   634     */

   635    virtual TPoint ViewPosition() const;

   636 

   637 private: // data

   638     

   639     /**

   640     * header container

   641     */

   642     CNcsHeaderContainer* iHeader;

   643     

   644     /**

   645     * message body field

   646     */

   647     CNcsEditor* iMessageField;

   648         

   649     /**

   650     * field for read-only quote used with some protocols on reply/forward

   651     */

   652     CNcsEditor* iReadOnlyQuoteField;

   653         

   654     /**

   655     * currently focused control

   656     */

   657     CCoeControl* iFocused;

   658     

   659     //<cmail>

   660     CAknLongTapDetector* iLongTapDetector;

   661     //</cmail>

   662     

   663     /**

   664     *

   665     */

   666     TPoint iContentBasePoint;

   667         

   668     /**

   669     *

   670     */

   671     CAknDoubleSpanScrollBar* iScrollBar;

   672         

   673     /**

   674     *

   675     */

   676     TAknDoubleSpanScrollBarModel iScrollBarModel;

   677         

   678     /**

   679     *

   680     */

   681     TRect iApplicationRect;

   682         

   683     /**

   684     *

   685     */

   686     HBufC* iLengthReference;

   687         

   688     /**

   689     * owner view

   690     */

   691     CNcsComposeView& iView;

   692         

   693     TInt iAmountMesFieldMovedUp;

   694         

   695     CFsAutoSaver& iAutoSaver;

   696 

   697     CAknsBasicBackgroundControlContext* iBgContext;

   698 

   699     /** Reference to current mailbox */

   700     CFSMailBox& iMailBox;

   701 		

   702     TAppendAddresses iAppendAddresses;

   703     //<cmail>

   704     TInt iSeparatorLineYPos;

   705     //</cmail>

   706     

   707     // panning related

   708     CAknPhysics* iPhysics;

   709     TPoint iPreviousPosition;

   710     TPoint iOriginalPosition;

   711     TBool iIsDragging;

   712     TBool iIsFlicking;

   713     TTime iStartTime;

   714     

   715     // for body editor row line drawing

   716     TInt iPrevDesiredHeigth;

   717     TInt iMessageEditorMinHeigth;

   718 

   719     // not owned contact handler pointer

   720     CFSEmailUiContactHandler* iContactHandler;

   721 

   722     // Descriptor for read-only quote text. Own.

   723     HBufC* iReadOnlyQuote;

   724     };

   725 

   726 

   727 #endif