idlehomescreen/examples/mcsexample/inc/MCSExampleDocument.h
author jake
Mon, 02 Aug 2010 12:02:47 +0300
branchRCL_3
changeset 70 d12a7ea0f775
permissions -rw-r--r--
Example applications for various Homescreen APIs.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
70
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
     1
/*
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
     2
* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
     3
* All rights reserved.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
     4
* This component and the accompanying materials are made available
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
     6
* which accompanies this distribution, and is available
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
     8
*
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
     9
* Initial Contributors:
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    11
*
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    12
* Contributors:
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    13
*
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    14
* Description:
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    15
*
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    16
*/
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    17
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    18
#ifndef __MCSEXAMPLEDOCUMENT_h__
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    19
#define __MCSEXAMPLEDOCUMENT_h__
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    20
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    21
// INCLUDES
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    22
#include <akndoc.h>
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    23
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    24
// FORWARD DECLARATIONS
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    25
class CMCSExampleAppUi;
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    26
class CEikApplication;
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    27
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    28
// CLASS DECLARATION
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    29
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    30
/**
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    31
 * CMCSExampleDocument application class.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    32
 * An instance of class CMCSExampleDocument is the Document part of the
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    33
 * AVKON application framework for the MCSExample example application.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    34
 */
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    35
class CMCSExampleDocument : public CAknDocument
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    36
    {
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    37
public:
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    38
    // Constructors and destructor
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    39
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    40
    /**
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    41
     * NewL.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    42
     * Two-phased constructor.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    43
     * Construct a CMCSExampleDocument for the AVKON application aApp
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    44
     * using two phase construction, and return a pointer
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    45
     * to the created object.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    46
     * @param aApp Application creating this document.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    47
     * @return A pointer to the created instance of CMCSExampleDocument.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    48
     */
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    49
    static CMCSExampleDocument* NewL(CEikApplication& aApp);
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    50
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    51
    /**
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    52
     * NewLC.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    53
     * Two-phased constructor.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    54
     * Construct a CMCSExampleDocument for the AVKON application aApp
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    55
     * using two phase construction, and return a pointer
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    56
     * to the created object.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    57
     * @param aApp Application creating this document.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    58
     * @return A pointer to the created instance of CMCSExampleDocument.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    59
     */
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    60
    static CMCSExampleDocument* NewLC(CEikApplication& aApp);
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    61
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    62
    /**
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    63
     * ~CMCSExampleDocument
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    64
     * Virtual Destructor.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    65
     */
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    66
    virtual ~CMCSExampleDocument();
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    67
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    68
public:
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    69
    // Functions from base classes
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    70
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    71
    /**
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    72
     * CreateAppUiL
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    73
     * From CEikDocument, CreateAppUiL.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    74
     * Create a CMCSExampleAppUi object and return a pointer to it.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    75
     * The object returned is owned by the Uikon framework.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    76
     * @return Pointer to created instance of AppUi.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    77
     */
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    78
    CEikAppUi* CreateAppUiL();
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    79
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    80
private:
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    81
    // Constructors
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    82
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    83
    /**
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    84
     * ConstructL
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    85
     * 2nd phase constructor.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    86
     */
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    87
    void ConstructL();
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    88
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    89
    /**
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    90
     * CMCSExampleDocument.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    91
     * C++ default constructor.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    92
     * @param aApp Application creating this document.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    93
     */
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    94
    CMCSExampleDocument(CEikApplication& aApp);
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    95
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    96
    };
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    97
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    98
#endif // __MCSEXAMPLEDOCUMENT_h__
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    99
// End of File