mobilemessaging/mmsui/notviewerinc/NotViewerDocument.h
changeset 0 72b543305e3a
equal deleted inserted replaced
-1:000000000000 0:72b543305e3a
       
     1 /*
       
     2 * Copyright (c) 2004 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:  
       
    15 *           Document class
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 
       
    21 #ifndef     NOTVIEWERDOCUMENT_H
       
    22 #define     NOTVIEWERDOCUMENT_H
       
    23 
       
    24 // INCLUDES
       
    25 #include <MsgEditorDocument.h>          // CMsgEditorDocument
       
    26 #include <mmsnotificationclient.h>
       
    27 #include "NotMtmUi.h"
       
    28 #include "NotMtmUiData.h"
       
    29 
       
    30 // CLASS DECLARATION
       
    31 
       
    32 /**
       
    33 *  CNotViewerDocument class
       
    34 *  Needed by the EIKON framework
       
    35 */
       
    36 class CNotViewerDocument : public CMsgEditorDocument
       
    37     {
       
    38     public:  // Constructors and destructor
       
    39         
       
    40         /**
       
    41         * C++ constructor.
       
    42         * @param aApp A CEikApplication reference
       
    43         */
       
    44         CNotViewerDocument( CEikApplication& aApp );
       
    45 
       
    46         /**
       
    47         * Two-phased constructor.
       
    48         * @param aApp A CEikApplication reference
       
    49         */
       
    50         static CNotViewerDocument* NewL( CEikApplication& aApp );  
       
    51         
       
    52         /**
       
    53         * Destructor.
       
    54         */
       
    55         virtual ~CNotViewerDocument();
       
    56 
       
    57     public: // New stuff
       
    58 
       
    59         /*
       
    60         * Mutator
       
    61         * Set the header modified flag.
       
    62         * @param aModified
       
    63         */
       
    64         inline void SetHeaderModified( TBool aModified );
       
    65 
       
    66         /*
       
    67         * Accessor
       
    68         * Get the header modified flag.
       
    69         *
       
    70         * @return iHeaderModified flag
       
    71         */
       
    72         inline TBool HeaderModified() const;
       
    73 
       
    74     public: // From CMsgEditorDocument
       
    75 
       
    76         /**
       
    77          *
       
    78          * @return
       
    79          */
       
    80         TMsvId DefaultMsgFolder() const;
       
    81 
       
    82         /**
       
    83          *
       
    84          * @return
       
    85          */
       
    86         TMsvId DefaultMsgService() const;
       
    87 
       
    88         /**
       
    89          *
       
    90          * @param aService
       
    91          * @param aFolder
       
    92          * @return
       
    93          */
       
    94         TMsvId CreateNewL(TMsvId aService, TMsvId aFolder);
       
    95 
       
    96         /**
       
    97          * Called when new entry is set.
       
    98          */
       
    99         void EntryChangedL();
       
   100 
       
   101         /**
       
   102          * Returns the current Mtm.
       
   103          * Overrides the function in Base Class
       
   104          * @return a reference to Notification Client MTM
       
   105          */
       
   106         CMmsNotificationClientMtm& Mtm() const;
       
   107 
       
   108         /**
       
   109          * Returns the current MtmUi.
       
   110          * Overrides the function in Base Class
       
   111          * @return a reference to Notification MTM UI
       
   112          */
       
   113         CNotMtmUi& MtmUi() const;
       
   114 
       
   115         /**
       
   116          * Returns the current MtmUi Data.
       
   117          * Overrides the function in Base Class
       
   118          * @return a reference to Notification MTM UI Data
       
   119          */
       
   120         CNotMtmUiData& MtmUiDataL() const;
       
   121 
       
   122     private:
       
   123 
       
   124         /**
       
   125         * By default Symbian OS constructor is private.
       
   126         */
       
   127         void ConstructL();
       
   128 
       
   129         /**
       
   130         * Creates a new CNotViewerAppUi
       
   131         * @return a pointer to CNotViewerAppUi
       
   132         */
       
   133         CEikAppUi* CreateAppUiL();
       
   134         
       
   135         /**
       
   136         * To prevent default-constructor...
       
   137         */
       
   138         CNotViewerDocument();
       
   139 
       
   140     private:
       
   141 
       
   142         TBool       iHeaderModified;
       
   143     };
       
   144 
       
   145 #include "NotViewerDocument.inl"
       
   146 
       
   147 #endif      //  NOTVIEWERDOCUMENT_H
       
   148             
       
   149 // End of File