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: declares compose view

    15 *

    16 */

    17 

    18 

    19 

    20 #ifndef __CNCSCOMPOSEVIEW_H__

    21 #define __CNCSCOMPOSEVIEW_H__

    22 

    23 //<cmail>

    24 #include "CFSMailCommon.h"

    25 #include "MFSMailRequestObserver.h"

    26 #include <alf/alfenv.h>

    27 #include "AknServerApp.h"

    28 #include <AknProgressDialog.h>

    29 #include <MsgAttachmentUtils.h>

    30 //</cmail>

    31 

    32 #include "FreestyleEmailUiViewBase.h"

    33 #include"FreestyleEmailUiConstants.h"

    34 #include"FSComposerFetchLogic.h"

    35 #include "FreestyleEmailUi.hrh"

    36 #include "cmailcustomstatuspaneindicators.h"

    37 

    38 class CNcsComposeViewContainer;

    39 class CFSMailClient;

    40 class CAlfControl;

    41 class CAlfAnchorLayout;

    42 class CFSMailBox;

    43 class CFSMailMessage;

    44 class CFSMailMessagePart;

    45 class CNcsEmailAddressObject;

    46 class CFSMailAddress;

    47 class CFSEmailCRHandler;

    48 class CFreestyleEmailUiAppUi;

    49 class CAlfEnv;

    50 class CFreestyleEmailUiSendAttachmentsListControl;

    51 class CMsvSession;

    52 class CAknsLayeredBackgroundControlContext;

    53 class CFsAutoSaver;

    54 class CAknWaitDialog; //<cmail>

    55 class CActiveHelper; //<cmail>

    56 

    57 

    58 const TInt KErrNcsComposeViewNotReady = KErrNotReady - 1000;

    59 

    60 /**

    61 * CNcsComposeView view class.

    62 */

    63 class CNcsComposeView: 

    64     public CFsEmailUiViewBase,

    65 	public MAlfActionObserver,

    66     public MComposerFetchLogicCallback,

    67     public MProgressDialogCallback,

    68     public MAknServerAppExitObserver

    69     {

    70     

    71 public:   // constructors and destructor

    72 

    73     /**

    74     * NewL.

    75     * Two-phased constructor.

    76     * Construct a CNcsComposeView for the AVKON application aApp.

    77     * Using two phase construction,and return a pointer to the created object

    78     * @return a pointer to the created instance of CNcsComposeView

    79     */

    80     static CNcsComposeView* NewL( 

    81         CFSMailClient& aMailClient,

    82         CAlfEnv& aEnv, 

    83         CFreestyleEmailUiAppUi* aAppUi,

    84         CAlfControlGroup& aControlGroup,

    85         CMsvSession& aMsvSession );

    86 

    87     /**

    88     * NewLC.

    89     * Two-phased constructor.

    90     * Construct a CNcsComposeView for the AVKON application aApp.

    91     * Using two phase construction,and return a pointer to the created object

    92     * @return a pointer to the created instance of CNcsComposeView

    93     */

    94     static CNcsComposeView* NewLC( 

    95         CFSMailClient& aMailClient,

    96         CAlfEnv& aEnv, 

    97         CFreestyleEmailUiAppUi* aAppUi,

    98         CAlfControlGroup& aControlGroup,

    99         CMsvSession& aMsvSession );

   100 

   101     /**

   102     * ~CNcsComposeView.

   103     * Virtual Destructor.

   104     */

   105     virtual ~CNcsComposeView();

   106         

   107     // Exit preparation function.

   108     void PrepareForExit();

   109         

   110 public: // from CFsEmailUiViewBase

   111     

   112     /**

   113     * Id

   114     * @return Id Uid value

   115     */

   116     TUid Id() const;

   117 

   118     /**

   119     * HandleCommandL

   120     * From CAknView, takes care of command handling.

   121     * @param aCommand Command to be handled

   122     */

   123     void HandleCommandL( TInt aCommand );

   124         

   125     // <cmail> Toolbar

   126     /**

   127     * DoActivateL

   128     * From CAknView, activate an AknView.

   129     * @param aPrevViewId The id of the previous view

   130     * @param aCustomMessageId message identifier

   131     * @param aCustomMessage custom message provided when the view is changed

   132     */

   133     /*void DoActivateL( const TVwsViewId& aPrevViewId, TUid aCustomMessageId,

   134                       const TDesC8& aCustomMessage );*/

   135     // </cmail> Toolbar

   136 

   137     /**

   138     * ChildDoDeactivate

   139     * Deactivate an AknView

   140     * Remove the container class instance from the App UI's stack and

   141     * deletes the instance

   142     */

   143     void ChildDoDeactivate();

   144         

   145     /**

   146     * DynInitMenuPaneL

   147     * Called by the framework before menu is shown to

   148     * show/hide items dynamically.

   149     * @param aResourceId The Id of the menu pane.

   150     * @param aMenuPane The menu pane.

   151     */

   152     void DynInitMenuPaneL( TInt aResourceId, CEikMenuPane* aMenuPane );

   153 

   154     /**

   155     * HandleDynamicVariantSwitchL

   156     * Recalculates component layout 

   157     */

   158     void HandleDynamicVariantSwitchL( CFsEmailUiViewBase::TDynamicSwitchType aType );

   159         

   160 public: // from MAlfActionObserver

   161     	

   162     void HandleActionL( const TAlfActionCommand& aActionCommand );

   163 

   164 public: // from MComposerFetchLogicCallback

   165 

   166     void FetchLogicComplete( TComposerFetchState aState, TInt aError );

   167 

   168 public: // new functions

   169 

   170     /**

   171     * LaunchAttachmentActionMenuL

   172     * Show action menu for the attachments line

   173     */

   174     void LaunchAttachmentActionMenuL();

   175     

   176 	//<cmail>

   177     /**

   178     * DismissAttachmentActionMenuL

   179     * Close action menu for the attachments line

   180     */

   181     void DismissAttachmentActionMenuL();

   182     //</cmail>

   183 	

   184     /**

   185     * AttachmentsListControl

   186     * Returns pointer to attachment list control

   187     */       

   188     CFreestyleEmailUiSendAttachmentsListControl* AttachmentsListControl();

   189 

   190     /**

   191     * NewMessage

   192     * Returns pointer to current composer message

   193     */    

   194     CFSMailMessage* NewMessage();

   195 

   196     /**

   197     * CommitL

   198     * Commits changes to message

   199     */

   200     void CommitL( TBool aParseAddresses = ETrue, 

   201                   TFieldToCommit aFieldToCommit = EAllFields );

   202 

   203     //<cmail>

   204     void DialogDismissedL( TInt aButtonId );

   205     

   206     void ShowFetchingWaitNoteL();

   207     

   208     TBool IsPreparedForExit();

   209     

   210     void AsyncExitL();

   211     //</cmail>

   212     

   213     // <cmail>

   214     void HandleContainerChangeRequiringToolbarRefresh();

   215     // </cmail>

   216 

   217 protected:

   218 

   219     void ProcessCommandL( TInt aCommand );

   220 

   221 // <cmail> Toolbar    

   222 private: // from

   223     

   224     /**

   225      * @see CFsEmailUiViewBase::ChildDoActivateL

   226      */

   227     void ChildDoActivateL( const TVwsViewId& aPrevViewId,

   228             TUid aCustomMessageId,

   229             const TDesC8& aCustomMessage );  

   230 

   231     /**

   232      *  @see CFsEmailUiViewBase::OfferToolbarEventL

   233      */

   234     void OfferToolbarEventL( TInt aCommand );

   235 

   236     /**

   237      * @see CFsEmailUiViewBase::ToolbarResourceId

   238      */

   239     TInt ToolbarResourceId() const;

   240     

   241     /**

   242      * @see CFsEmailUiViewBase::GetInitiallyDimmedItemsL

   243      */   

   244     void GetInitiallyDimmedItemsL( const TInt aResourceId, 

   245             RArray<TInt>& aDimmedItems ) const;

   246     

   247     /**

   248      * Update toolbar items.

   249      */

   250     void RefreshToolbar();    

   251 // </cmail> Toolbar     

   252     

   253 private: // new functions

   254     

   255     /**

   256     * HandleActivationCommandL

   257     * Called from DoActivateL() to do the part of view activation which depends on the

   258     * activation command given in TUid argument.

   259     */

   260     void HandleActivationCommandL( TUid aCustomMessageId );

   261 

   262     /**

   263     * DoSaveDraftL

   264     * Saves message to drafts

   265     * @param aAskUser If ETrue asks user whether to save.

   266     * @return ETrue if option was select and 

   267     *         EFalse if Cancel was pressed, or if saving failed.

   268     */

   269     TBool DoSaveDraftL( TBool aAskUser );

   270         

   271     /**

   272     * DoSendL

   273     * Sends email message.

   274     */

   275     void DoSendL();

   276         

   277     enum TExitMode 

   278         {

   279         ESaveDraftQuery,

   280         ESaveDraft,

   281         ENoSave

   282         };

   283         

   284     /**

   285     * DoSafeExit

   286     */

   287     void DoSafeExit( TExitMode aMode=ESaveDraftQuery );

   288 

   289     /**

   290     * DoExitL

   291     * Handler called when exiting the view.

   292     */

   293     void DoExitL( TExitMode aMode=ESaveDraftQuery );

   294         

   295     /**

   296     * DoOpenAttachmentListL

   297     * Saves current editor message to drafts and opens

   298     * attachment list

   299     */

   300     void DoOpenAttachmentListL();

   301         

   302     /**

   303     * SetAttachmentLabelContent

   304     * Set files from model to view label

   305     */       

   306     void SetAttachmentLabelContentL();

   307         

   308     /**

   309     * GetAttachmentsFromMail

   310     * get list of attachments from mail

   311     */       

   312     void GetAttachmentsFromMailL();

   313         

   314     /**

   315     * FileExistsInModel

   316     * Check for duplicates in model when reading attachments from mail

   317     */       

   318     TBool FileExistsInModel( TFSMailMsgId aAttachmentId );

   319 

   320     /**

   321     * DoQuickTextL

   322     * Display the Quick Text dialog

   323     */

   324     void DoQuickTextL();

   325         

   326     /**

   327     * DoAddAttachmentL

   328     * Add attachment file to message

   329     */

   330     static TInt AsyncAddAttachment( TAny* aSelfPtr );

   331     

   332     /**

   333     * RunFollowUpFlagDlgL()

   334     * Query user for followup flag

   335     */

   336     void RunFollowUpFlagDlgL();

   337     

   338     /**

   339     * InitFieldsL

   340     * Inits fields with message data.

   341     */       

   342     void InitFieldsL();

   343  

   344     /**

   345     * InitReplyFieldsL

   346     * Inits fields when composing reply message.

   347     * @param aReplyAll ETrue if this is replyall message.

   348     */       

   349     void InitReplyFieldsL( TBool aReplyAll );

   350 

   351     /**

   352     * RemoveOwnAddress

   353     * Removes own address while doing reply all.

   354     * @param aAddressList The address list.

   355     */       

   356     void RemoveOwnAddress( RPointerArray<CNcsEmailAddressObject>& aAddressList );

   357          

   358     /**

   359     * InitForwardFieldsL

   360     * Inits fields when composing forward message.

   361     */       

   362     void InitForwardFieldsL();

   363         

   364     /**

   365     * IncludeMessageTextL

   366     * Inits body text when forwarding, replying, or opening draft message.

   367     * @param aEnsureEmptyLineInBegin When true, the function ensures there's empty lines

   368     *                                in the beginning of the message. I.e. line break(s)

   369     *                                are inserted in front of any quote or signature

   370     */        

   371     void IncludeMessageTextL( TBool aEnsureSpaceInBegin = EFalse );

   372         

   373     /**

   374     * SetPriority

   375     * Sets priority when using saved draft.

   376     */

   377     void SetPriority();

   378 

   379     /**

   380      * Sets follow-up flag to status pane indicator from draft message.

   381      */

   382     void SetFollowUp();

   383 

   384     /**

   385     * GetMessageBodyL

   386     * Gets message body in a buffer.

   387     * @return Message body

   388     */

   389     HBufC* GetMessageBodyL();

   390         

   391     /**

   392     * ReturnToPreviousViewL

   393     * Exit editor and return to previous view

   394     */

   395     void ReturnToPreviousViewL();

   396         

   397     /**

   398     * FetchTextPartL

   399     * Fetch text part

   400     * @param aMsg The message whiches text part is to be fetched

   401     */

   402     void FetchTextPartL( CFSMailMessage& aMsg );

   403 	

   404     /**

   405      * Do the needed initializations for reply/reply all/forward commands

   406      * depending on the iCustomMessageId.

   407      */

   408     void InitReplyOrForwardUiL();

   409     

   410     /**

   411     * GenerateReplyMessageL

   412     * Creates reply message

   413     * @param aReplyAll ETrue for reply all and EFalse for reply

   414     */

   415     void GenerateReplyMessageL( TBool aReplyAll );

   416 		

   417     /**

   418     * InitReplyUiL

   419     * Inits UI in reply case

   420     * @param aReplyAll ETrue for reply all and EFalse for reply

   421     */

   422     void InitReplyUiL( TBool aReplyAll );

   423 		

   424     /**

   425     * GenerateForwardMessageL

   426     * Creates forward message

   427     */

   428     void GenerateForwardMessageL();

   429 		

   430     /**

   431     * InitForwardUiL

   432     * Inits UI in forward case

   433     */

   434     void InitForwardUiL();

   435 		

   436     /**

   437     * InitUiGeneralL

   438     * Inits UI in general case

   439     */

   440     void InitUiGeneralL();

   441     /**

   442     * GenerateReplyHeaderLC

   443     * Creates header lines for reply/forward message

   444     * @return Reply header

   445     */

   446     HBufC* GenerateReplyHeaderLC();

   447 

   448     /**

   449     * GenerateSmartTagLC

   450     * Creates smart reply/forward tag

   451     * @return Smart tag

   452     */

   453     HBufC* GenerateSmartTagLC();

   454         

   455     /**

   456     * SetReplyForwardFlagL

   457     * Set reply/forward flag into original message if needed

   458     */

   459     void SetReplyForwardFlagL();

   460         

   461     /**

   462     * LoadBackgroundImageAndSetBackgroundContextL

   463     * Loads bg image and creates local skin item from that

   464     * @param aRect Background rectangle

   465     */

   466 //        void LoadBackgroundImageAndSetBackgroundContextL( const TRect& aRect );

   467         

   468     /**

   469     * MailBoxSupportsSmartReply

   470     * @return ETrue if mailbox supports smart reply

   471     */

   472     TBool MailBoxSupportsSmartReply();

   473 

   474     /**

   475     * MailBoxSupportsSmartForward

   476     * @return ETrue if the mailbox supports smart forward

   477     */

   478     TBool MailBoxSupportsSmartForward();

   479         

   480     /**

   481     * HasUnfetchedAttachmentsL

   482     * @param aMsg Message to be tested

   483     * @return ETrue if the message has unfetched attachments

   484     */

   485     TBool HasUnfetchedAttachmentsL( CFSMailMessage& aMsg );

   486         

   487     /**

   488     * SaveToDraftsL

   489     * @param aParseAddresses ETrue to parse text in address fields now

   490     */

   491     void SaveToDraftsL( TBool aParseAddresses );

   492         

   493     void ExitComposer();

   494         

   495     void CreateContainerL();

   496 

   497     void ResetComposer();

   498     

   499     void SaveAndCleanPreviousMessage();

   500     

   501     // First start function to improve app loading perf.

   502     void DoFirstStartL();

   503     

   504     static TInt AsyncExit( TAny* aSelfPtr );

   505     

   506     //void AsyncExitL(); //<cmail> made public

   507 private:   // Constructors and destructor

   508 

   509     /**

   510     * CNcsComposeView

   511     * C++ default constructor.

   512     * @param aAppUi App UI

   513     * @param aEnv Alfred environment

   514     * @param aSendAttachmentControlGroup Send attachment control group

   515     * @param aMailClient Email framework client object.

   516     * @param aBgControl Background control.

   517     */

   518     CNcsComposeView( CFreestyleEmailUiAppUi& aAppUi, CAlfEnv& aEnv, CAlfControlGroup& aControlGroup, CFSMailClient& aMailClient, CMsvSession& aMsvSession );

   519 

   520     /**

   521     * ConstructL

   522     * 2nd phase constructor.

   523     */

   524     void ConstructL();

   525         

   526 private: // data

   527     

   528     /**

   529     * control container

   530     */

   531     CNcsComposeViewContainer* iContainer;

   532 

   533     /**

   534     * view identifier

   535     */

   536     TUid iIdentifier;

   537         

   538     /**

   539     * email framework client

   540     */

   541     CFSMailClient& iMailClient;

   542 

   543     /**

   544     * email framework mailbox

   545     */		

   546     CFSMailBox* iMailBox;

   547     	

   548     /**

   549     * original message

   550     */

   551     CFSMailMessage* iOrigMessage;

   552     	

   553     /**

   554     * new message

   555     */

   556     CFSMailMessage* iNewMessage;

   557     	

   558     /**

   559     * new message text part

   560     */

   561     CFSMailMessagePart* iNewMessageTextPart;

   562 

   563     /**

   564     * central repository handler

   565     */        

   566     CFSEmailCRHandler* iCrHandler;

   567         

   568     /**

   569     * launch parameters

   570     */

   571     TEditorLaunchParams iLaunchParams;

   572         

   573     /**

   574     * flag to indicate on exit whether mail was sent

   575     */

   576     TBool iMailSent;

   577 

   578     /**

   579     * flag to indicate on exit whether mail sending failed

   580     */

   581     TBool iMailSendFailed;

   582 

   583     /**

   584     * error code for fetching message, KErrNone if fetched succesfully

   585     */

   586     TInt iMailFetchingErrCode;

   587     

   588     /**

   589     * flag to indicate whether view is ready to handle user commands

   590     */ 

   591     TBool iViewReady;

   592     

   593     /**

   594     * flag to indicate is save to draft called by attachment list

   595     */

   596     TBool iAttachmentListSaveDraft;

   597         

   598     /**

   599     * session to messaging server

   600     */

   601     CMsvSession& iMsvSession;

   602         

   603     /**

   604     * stored TUid passes to DoActivateL

   605     */

   606     TUid iCustomMessageId;

   607 

   608     /**

   609     * background size

   610     */

   611     TSize iBackgroundImageSize;

   612 

   613     /**

   614     * alfred environment

   615     */

   616     CAlfEnv& iEnv;

   617         

   618     /**

   619     * autosave

   620     */

   621     CFsAutoSaver* iAutoSaver;

   622         

   623     /**

   624     * fetch logic

   625     */

   626     CFsComposerFetchLogic* iFetchLogic;

   627 

   628     TBool iFirstStartCompleted;

   629 

   630     /**

   631      * dialog query (send or delete)

   632      */

   633     CAknListQueryDialog* iDlg;

   634 

   635     /**

   636      * checkquery (send or delete)

   637      */

   638     TBool iCheckQuery;

   639     

   640     CAsyncCallBack* iAsyncCallback;

   641     

   642     CAknWaitDialog* iFetchWaitDialog; //<cmail>

   643     

   644     //<cmail>

   645     //when some plugin makes fake sync, we need these

   646     TBool iFakeSyncGoingOn;

   647     TBool iFetchDialogCancelled;

   648     CActiveHelper* iActiveHelper;

   649  

   650     // For the fake synchronous operations of the mail plugin run in DoExitL

   651     // we need to knwo when the method is running and block all the commands

   652     // during that time.

   653     TBool iExecutingDoExitL;

   654    //</cmail>

   655     

   656     CAsyncCallBack* iAsyncAttachmentAdd;

   657     MsgAttachmentUtils::TMsgAttachmentFetchType iAttachmentAddType;

   658     

   659     // Status pane indicators (priority and followup)

   660     CCustomStatuspaneIndicators* iStatusPaneIndicators;

   661     };

   662 

   663 //<cmail>

   664 /**

   665 * This class is used by CNcsComposeView for waiting its own async tasks.

   666 *  

   667 * @since S60 v3.2

   668 */    

   669 class CActiveHelper : public CActive

   670     {

   671     public: // public functions

   672     

   673         /**

   674         * Default 1st phase factory method.

   675         * Creates an instance of CCacheSessionActiveHelper

   676         *

   677         * @return created instance of the CCacheSessionActiveHelper

   678         */

   679         static CActiveHelper* NewL(CNcsComposeView* aComposeView );

   680         

   681         /**

   682         * Destructor

   683         */

   684         ~CActiveHelper( );

   685         

   686         /**

   687         * Active object start

   688         */

   689         void Start();

   690     

   691     private: // private functions

   692         

   693         /**

   694         * Constructor

   695         */

   696         CActiveHelper(CNcsComposeView* aSession);

   697 

   698         /**

   699         * Active object RunL

   700         */

   701         void RunL();

   702         

   703         /**

   704         * Active object DoCancel

   705         */

   706         void DoCancel();

   707         

   708         /**

   709         * ConstructL

   710         */

   711         void ConstructL();

   712         

   713         /**

   714         * pointer to CNcsComposeView doesnt own

   715         */

   716         CNcsComposeView* iComposeView;

   717             

   718     };

   719 //</cmail>

   720 

   721 #endif // CNCSCOMPOSEVIEW_H

   722 

   723 

   724 // End of File