phonebookui/Phonebook2/Application/inc/CPbk2Document.h
branchRCL_3
changeset 63 f4a778e096c2
parent 0 e686773b3f54
equal deleted inserted replaced
62:5b6f26637ad3 63:f4a778e096c2
       
     1 /*
       
     2 * Copyright (c) 2005-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:  Phonebook 2 document.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef CPBK2DOCUMENT_H
       
    20 #define CPBK2DOCUMENT_H
       
    21 
       
    22 // INCLUDES
       
    23 #include <CPbk2DocumentBase.h>
       
    24 
       
    25 // FORWARD DECLARATIONS
       
    26 class CPbk2Application;
       
    27 class CPbk2UIExtensionManager;
       
    28 class MPbk2ApplicationServices;
       
    29 class CPbk2UIApplicationServices;
       
    30 
       
    31 // CLASS DECLARATION
       
    32 
       
    33 /**
       
    34  * Phonebook 2 document class.
       
    35  * An object of this class is created by the Symbian OS framework by a call
       
    36  * to CPbk2Application::CreateDocumentL(). The application framework
       
    37  * creates the Phonebook 2 application UI object (CPbk2AppUi) by a call
       
    38  * to the virtual function CreateAppUiL().
       
    39  *
       
    40  * Responsible for creating application UI and creating and owning
       
    41  * application services object and UI extension manager.
       
    42  */
       
    43 class CPbk2Document : public CPbk2DocumentBase
       
    44     {
       
    45     public: // Construction
       
    46 
       
    47         /**
       
    48          * Creates a new instance of this class.
       
    49          *
       
    50          * @param aApp  Reference to Eikon application object.
       
    51          * @return  A new instance of this class.
       
    52          */
       
    53         static CPbk2Document* NewL(
       
    54                 CEikApplication& aApp );
       
    55 
       
    56     public: // Interface
       
    57 
       
    58         /**
       
    59          * Returns the Phonebook 2 application object.
       
    60          *
       
    61          * @return  Phonebook 2 application object.
       
    62          */
       
    63         CPbk2Application* Pbk2Application() const;
       
    64 
       
    65         /**
       
    66          * Initializes Phonebook 2 application globals.
       
    67          */
       
    68         void CreateGlobalsL();
       
    69 
       
    70         /**
       
    71          * Initializes Phonebook 2 application services.
       
    72          *
       
    73          * @return  Phonebook 2 application services.
       
    74          */
       
    75         MPbk2ApplicationServices* ApplicationServicesL();
       
    76 
       
    77 
       
    78     public: // From CPbk2DocumentBase
       
    79         CPbk2UIExtensionManager& ExtensionManager() const;
       
    80 
       
    81     private: // From CAknDocument
       
    82         CEikAppUi* CreateAppUiL();
       
    83 
       
    84     private:  // Implementation
       
    85         CPbk2Document(
       
    86                 CEikApplication& aApp );
       
    87         ~CPbk2Document();
       
    88         void ConstructL();
       
    89 
       
    90     private: // Data
       
    91         /// Own: UI Extension manager
       
    92         CPbk2UIExtensionManager* iExtensionManager;
       
    93         /// Own: Application services
       
    94         CPbk2UIApplicationServices* iAppServices;
       
    95     };
       
    96 
       
    97 #endif // CPBK2DOCUMENT_H
       
    98 
       
    99 // End of File