S60 3rd Edition SDK for Symbian OS Example Applications Guide

LandmarksAppUi.h

/*
* ==============================================================================
*  Name        : LandmarksAppUi.h
*  Part of     : Landmark Reference Application
*  Interface   : -
*  Description : See class description below
*  Version     : 1.0
*
*  Copyright (c) 2004-2006 Nokia Corporation.
*  This material, including documentation and any related 
*  computer programs, is protected by copyright controlled by 
*  Nokia Corporation.
* ==============================================================================
*/

#ifndef __LANDMARKS_APPUI_H__
#define __LANDMARKS_APPUI_H__

// INCLUDES
#include "LandmarksOperationObserver.h"
#include <aknviewappui.h>
#include <aknprogressdialog.h>
#include <AknTabObserver.h> 

// FORWARD DECLARATIONS
class CLandmarksApplicationEngine;
class CLandmarksCategoriesView;
class CAknNavigationDecorator;
class CLandmarksListView;
class CAknProgressDialog;

// CLASS DECLARATION

/**
*  An instance of class CLandmarksAppUi is the UserInterface part of the Eikon
*  application framework for the Landmarks reference application
*/
class CLandmarksAppUi : 
    public CAknViewAppUi, 
    public MLandmarksOperationObserver, 
    public MAknTabObserver,
    public MProgressDialogCallback
    {
    public: // Constructors and destructor

        /**
        * C++ default constructor. This needs to be public due to the way 
        * the framework constructs the AppUi.
        */
        CLandmarksAppUi();

        /**
        * Symbian 2nd phase constructor. This needs to be public due to the way 
        * the framework constructs the AppUi.
        */
        void ConstructL();

        /**
        * Destructor.
        */
        ~CLandmarksAppUi();

    public: // from CEikAppUi

        /** 
        * HandleCommandL handles user menu selections.
        *
        * @param aCommand the enumerated code for the option selected
        */
        void HandleCommandL(TInt aCommand);
        
    public: // from CCoeAppUi

        /**
        * HandleKeyEventL handles key events.
        *
        * @param aKeyEvent Event to handle.
        * @param aType Type of the key event.
        * @return Reponse code (EKeyWasConsumed, EKeyWasNotConsumed).
        */
        TKeyResponse HandleKeyEventL(
            const TKeyEvent& aKeyEvent,
            TEventCode aType);

    public: // from MLandmarksOperationObserver

        /**
        * NotifyOperationProgressL notifies the progress and status of an
        * asynchronous operation.
        *  
        * @param aOperation the type of operation that is reported.
        * @param aProgress the progress of the operation.
        * @param aErrorCode the status of the operation.
        */
        void NotifyOperationProgressL(
            TOperation aOperation, 
            TInt aProgress, 
            TInt aErrorCode);

    public: // from MAknTabObserver
        
        /** Called by NaviDecorator when tab is changed
        * @param aIndex new tab seleected
        */
        void TabChangedL(TInt aIndex);

    public: // from MProgressDialogCallback

        /**
        * Called when the dialog has been dismissed.
        * 
        * @param aButtonId the button that was pressed to dismiss the dialog.
        */
        void DialogDismissedL(TInt aButtonId);

    private:

        /**
        * Performs the construction phase of this object that is dependent 
        * that the application engine is initialized.
        */
        void PostConstructL();

        /**
        * Launches a progress dialog displayed when the default landmark 
        * database is initialized.
        */
        void LaunchProgressDialogL();

    private: // Data

        //! decorates the navi pane (with navigation arrows etc)
        CAknNavigationDecorator* iNaviDecorator;

        //! the application engine
        CLandmarksApplicationEngine* iEngine;

        /** displays a progress bar when initializing the 
            default landmark database. */
        CAknProgressDialog* iProgressDialog;

        /** indicates if exit has been pressed before the 
            progressDialog is fully deleted */
        TBool iDelayedExit;

    };

#endif // __LANDMARKS_APPUI_H__

// End of File

---

© Nokia 2006