locationsystemui/locationsysui/locverifier/inc/lpdglobalplugindialog.h
author Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
Tue, 02 Feb 2010 01:06:48 +0200
changeset 0 667063e416a2
permissions -rw-r--r--
Revision: 201003 Kit: 201005

/*
* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies). 
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of "Eclipse Public License v1.0"
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description:  List query dialog suitable for verifier plug-in use.
*
*/


#ifndef CLPDGLOBALPLUGINDIALOG_H
#define CLPDGLOBALPLUGINDIALOG_H

// INCLUDES
#include <aknlistquerydialog.h>
#include "lpdbkupevtobserver.h"

// FORWARD DECLARATIONS
class MLpdDlgObserver;
class CLpdBkupEvtListenerAO;
class MLpdBkupEvtObserver;

// CLASS DECLARATION

/**
*  A list query dialog suitable for verifier plug-in use.
*  Inherits from CAknListQueryDialog, utilizes MLpdDlgObserver
*  for notifying when dialog is dismissed.
*
*  @lib locverifierdlg.lib
*  @since 2.1
*/
class CLpdGlobalPluginDialog : public CAknListQueryDialog, public MLpdBkupEvtObserver
	{
    public:  // Constructors and destructor

        /**
        * Two-phased constructor.
        * @param aCallBack is notified when dialog is dismissed
        * @param aSelfPtr caller's ptr is set to null when dialog is deleted
        * @param aSelected will contain selected items when available, i.e.
        *                  since observer callback (in multiselectionlist)
        * @return created object
        */
        static CLpdGlobalPluginDialog* NewL(
                    MLpdDlgObserver& aCallBack,
                    CLpdGlobalPluginDialog ** aSelfPtr,
                    CListBoxView::CSelectionIndexArray* aSelected = NULL );

		
        /**
        * C++ destructor.
        */
        virtual ~CLpdGlobalPluginDialog();

    public: // Functions from base classes

        /**
        * From CAknDialog. Wrapper method for enabling better unit testing
        * when using a stub implementation.
        * @param aResourceId
        */
        void PrepareLC( TInt aResourceId );

        /**
        * Wrapper that suppresses application switching
        * and call's base class RunLD().
        */
        TInt RunLD();

        /**
        * From CAknListQueryDialog.
        * @param aKeyEvent
        * @param aType
        * @return EKeyWasConsumed if key was consumed by dialog
        */
        TKeyResponse OfferKeyEventL( const TKeyEvent& aKeyEvent,
                                     TEventCode aType );

		void HandleResourceChange(TInt aType);

    public: // New functions

        /**
        * Sets header text of the dialog.
        * It is intended to be called before executing the dialog.
        * @param aText
        */
        void SetHeaderTextL( const TDesC& aText );

        /**
        * Allows exiting the dialog without user action.
        * Can be called e.g. in case of timeout. Main reason for
        * this method is that deleting a dialog is not a proper
        * way to exit it. Calling this method causes
        * MLpdDlgObserver::HandleDlgDismissedL() callback with
        * EEikCmdExit result.
        */
        void ExitDialogL();

        /**
        * Similar as ExitDialogL(), but no callback method
        * is called.
        */
        void ExitDialogQuietlyL();

    protected: // Functions from base classes

        /**
        * From CAknListQueryDialog.
        * @param aButtonId
        * @return ETrue if dialog can be dismissed
        */
        TBool OkToExitL(TInt aButtonId);

    private:  // Constructors and destructor

        /**
        * Symbian 2nd Phase Constructor.
        */
		void ConstructL();

        /**
        * C++ constructor.
        * @param aCallBack is notified when dialog is dismissed
        * @param aSelfPtr caller's ptr is set to null when dialog is deleted
        * @param aSelected will contain selected items when available, i.e.
        *                  since observer callback (in multiselectionlist)
        */
        CLpdGlobalPluginDialog(
                    MLpdDlgObserver& aCallBack,
                    CLpdGlobalPluginDialog ** aSelfPtr,
                    CListBoxView::CSelectionIndexArray* aSelected );

    private:    // Data

        // Object which is notified when query is dismissed
        MLpdDlgObserver& iCallBack;

        // Holds the status of application switching
        TBool iAppSwitchSuppressed;

        // Contains indexes of selected item
        CListBoxView::CSelectionIndexArray* iSelected; // does not own

        // Caller's pointer to this query object is set to NULL
        // when ExecuteLD destroys the object
        CLpdGlobalPluginDialog** iSelfPtr;

        // Index given to base class, not used
        TInt iDummyIndex;
        
        // Reference to the Backup Event Listener
        CLpdBkupEvtListenerAO* iBkupListener;
        
	};

#endif      // CLPDGLOBALPLUGINDIALOG_H   
            
// End of File