/*
* Copyright (c) 2009 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:
* WidgetManager configuration class
*
*/

#ifndef WMCONFIGURATION_H
#define WMCONFIGURATION_H

// INCLUDE FILES
#include <e32base.h>

// FORWARD DECLARATIONS
class CRepository;
class CWmResourceLoader;

/**
 * Configuration class for Widget Manager
 * 
 * @class CWmConfiguration
 */
NONSHARABLE_CLASS( CWmConfiguration ) : public CBase
	{
	
public: // constructors and destructor
	
    /** Two-phased constructor. */
	static CWmConfiguration* NewL(
	        CWmResourceLoader& aResourceLoader );

	/** Destructor */
	virtual ~CWmConfiguration();
	
private:
    /** constructor */
    CWmConfiguration(
            CWmResourceLoader& aResourceLoader );
    
    /** 2nd phase constructor */
    void ConstructL();

public: // API

    /**
     * portal button methods. This - along with the parameter -
     * represents the action that the portal button is configured
     * to do when pressed. The portal button itself should contain
     * the execution code itself.
     */
    enum TMethod
        {
        ENone = 0, // no method
        EHttp, // open browser to a certain page
        EWidget, // open given widget with params
        EApplication // launch an application
        };

    /**
     * Number of portal buttons (1 or more)
     */
    TInt PortalButtonCount();

    /**
     * Label text to be displayed on a portal button
     * @param aIndex index of the button, starting at 0
     */
    const TDesC& PortalButtonText( TInt aIndex );
    
    /**
     * Icon to be displayed on a portal button
     * Logo syntax follows the widget icon syntax in CWmImageConverter
     * @param aIndex index of the button, starting at 0
     */
    const TDesC& PortalButtonIcon( TInt aIndex );
    
    /**
     * Portal button action method.
     * Defines what happens when the portal button is pressed.
     * @param aIndex index of the button, starting at 0
     */
    TMethod PortalButtonPrimaryMethod( TInt aIndex );
    
    /**
     * Service name for the primary method.
     * For EHttp this is unused.
     * For EWidget, this is the widget Bundle ID.
     * For EApplication, this is the application name.
     * @param aIndex index of the button, starting at 0
     */
    const TDesC& PortalButtonPrimaryService( TInt aIndex );
    
    /**
     * parameters related to the method.
     * For EHttp this is the HTTP address
     * For EWidget the parameters passed to the widget
     * For EApplication the params passed to the app.
     * @param aIndex index of the button, starting at 0
     */
    const TDesC& PortalButtonPrimaryParams( TInt aIndex );
    
    /**
     * Secondary method, which is excuted if
     * primary method fails.
     * Works like Primary method.
     * @param aIndex index of the button, starting at 0
     */
    TMethod PortalButtonSecondaryMethod( TInt aIndex );
    
    /**
     * Service name for the primary method.
     * For EHttp this is unused.
     * For EWidget, this is the widget Bundle ID.
     * For EApplication, this is the application name.
     * @param aIndex index of the button, starting at 0
     */
    const TDesC& PortalButtonSecondaryService( TInt aIndex );
    
    /**
     * Parameters for Secondary method. Like Primary method
     * Works like Primary params.
     * @param aIndex index of the button, starting at 0
     */
    const TDesC& PortalButtonSecondaryParams( TInt aIndex );
    
private: // New functions
    
    void LoadConfigurationL();
    TInt FindCorrectLanguageId();
    HBufC* ReadParameterL( TInt aKey );
    HBufC* ReadLocalisedParameterL( TInt aOffset );
    void IndexConversion( TInt& aIndex );

private:

    /**
     * the central repository
     */
    CRepository*            iRepository;

    /**
     * the resource loader
     */
    CWmResourceLoader&      iResourceLoader;

    /**
     * The index in cenrep that matches current
     * system language
     */
    TInt                    iLanguageIndex;

    /**
     * OVI store button text
     */
    HBufC*                  iOviButtonTitle;
    
    /**
     * OVI store button icon
     */
    HBufC*                  iOviButtonIcon;
    
    /**
     * OVI store button browser Url
     * (browser is used if OVI client is not working)
     */
    HBufC*                  iOviButtonUrl;
    
    /**
     * OVI store button widget client param
     */
    HBufC*                  iOviStoreClientParam;
    
    /**
     * OVI store button widget bundle ID
     */
    HBufC*                  iOviStoreBundleId;
    
    /**
     * OPERATOR button text
     */
    HBufC*                  iOperatorButtonTitle;
    
    /**
     * OPERATOR store icon
     */
    HBufC*                  iOperatorButtonIcon;
    
    /**
     * OPERATOR store button browser Url
     */
    HBufC*                  iOperatorButtonUrl;
    
    };

#endif // WMCONFIGURATION_H

// End of File