1 /*

     2 * Copyright (c) 2009 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 document class for application.

    15  *

    16 */

    17 

    18 

    19 #ifndef __AKNCONFDOCUMENT_H__

    20 #define __AKNCONFDOCUMENT_H__

    21 

    22 // INCLUDES

    23 #include <AknDoc.h>

    24 

    25 // FORWARD DECLARATIONS

    26 class CAknConfAppUi;

    27 class CEikApplication;

    28 

    29 // CLASS DECLARATION

    30 

    31 /**

    32  * CAknConfDocument application class.

    33  * An instance of class CAknConfDocument is the Document part of the

    34  * AVKON application framework for the aknconf example application.

    35  */

    36 class CAknConfDocument : public CAknDocument

    37     {

    38 public:

    39     // Constructors and destructor

    40 

    41     /**

    42      * NewL.

    43      * Two-phased constructor.

    44      * Construct a CAknConfDocument for the AVKON application aApp

    45      * using two phase construction, and return a pointer

    46      * to the created object.

    47      * @param aApp Application creating this document.

    48      * @return A pointer to the created instance of CAknConfDocument.

    49      */

    50     static CAknConfDocument* NewL(CEikApplication& aApp);

    51 

    52     /**

    53      * NewLC.

    54      * Two-phased constructor.

    55      * Construct a CAknConfDocument for the AVKON application aApp

    56      * using two phase construction, and return a pointer

    57      * to the created object.

    58      * @param aApp Application creating this document.

    59      * @return A pointer to the created instance of CAknConfDocument.

    60      */

    61     static CAknConfDocument* NewLC(CEikApplication& aApp);

    62 

    63     /**

    64      * ~CAknConfDocument

    65      * Virtual Destructor.

    66      */

    67     virtual ~CAknConfDocument();

    68 

    69 public:

    70     // Functions from base classes

    71 

    72     /**

    73      * CreateAppUiL

    74      * From CEikDocument, CreateAppUiL.

    75      * Create a CAknConfAppUi object and return a pointer to it.

    76      * The object returned is owned by the Uikon framework.

    77      * @return Pointer to created instance of AppUi.

    78      */

    79     CEikAppUi* CreateAppUiL();

    80 

    81 private:

    82     // Constructors

    83 

    84     /**

    85      * ConstructL

    86      * 2nd phase constructor.

    87      */

    88     void ConstructL();

    89 

    90     /**

    91      * CAknConfDocument.

    92      * C++ default constructor.

    93      * @param aApp Application creating this document.

    94      */

    95     CAknConfDocument(CEikApplication& aApp);

    96 

    97     };

    98 

    99 #endif // __AKNCONFDOCUMENT_H__

   100 // End of File