idlehomescreen/examples/mcsexample/inc/MCSExampleAppUi.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 __MCSEXAMPLEAPPUI_h__
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    19
#define __MCSEXAMPLEAPPUI_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 <aknappui.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 CMCSExampleAppView;
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    26
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    27
// CLASS DECLARATION
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    28
/**
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    29
 * CMCSExampleAppUi application UI class.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    30
 * Interacts with the user through the UI and request message processing
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    31
 * from the handler class
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    32
 */
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    33
class CMCSExampleAppUi : public CAknAppUi
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    34
    {
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    35
public:
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    36
    // Constructors and destructor
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    37
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    38
    /**
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    39
     * ConstructL.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    40
     * 2nd phase constructor.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    41
     */
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    42
    void ConstructL();
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    43
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    44
    /**
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    45
     * CMCSExampleAppUi.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    46
     * C++ default constructor. This needs to be public due to
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    47
     * the way the framework constructs the AppUi
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    48
     */
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    49
    CMCSExampleAppUi();
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
     * ~CMCSExampleAppUi.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    53
     * Virtual Destructor.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    54
     */
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    55
    virtual ~CMCSExampleAppUi();
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    56
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    57
private:
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    58
    // Functions from base classes
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    59
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    60
    /**
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    61
     * From CEikAppUi, HandleCommandL.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    62
     * Takes care of command handling.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    63
     * @param aCommand Command to be handled.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    64
     */
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    65
    void HandleCommandL(TInt aCommand);
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    66
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    67
    /**
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    68
     *  HandleStatusPaneSizeChange.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    69
     *  Called by the framework when the application status pane
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    70
     *  size is changed.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    71
     */
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    72
    void HandleStatusPaneSizeChange();
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    73
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    74
    /**
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    75
     *  From CCoeAppUi, HelpContextL.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    76
     *  Provides help context for the application.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    77
     *  size is changed.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    78
     */
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    79
    CArrayFix<TCoeHelpContext>* HelpContextL() const;
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    80
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    81
private:
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    82
    // Data
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    83
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    84
    /**
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    85
     * The application view
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    86
     * Owned by CMCSExampleAppUi
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    87
     */
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    88
    CMCSExampleAppView* iAppView;
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    89
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    90
    };
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    91
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    92
#endif // __MCSEXAMPLEAPPUI_h__
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    93
// End of File