common/tools/ats/smoketest/localisation/apparchitecture/apserv/apsiconcaptionoverride.h
author victorp@symbian.org
Wed, 03 Feb 2010 16:06:24 +0000
changeset 872 17498133d9ad
parent 793 0c32c669a39d
permissions -rw-r--r--
adding EPL headers to smoke test

// 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 the License "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:
//



/**
 @internalComponent
*/


#ifndef APSICONCAPTIONOVERRIDE_H
#define APSICONCAPTIONOVERRIDE_H

#include <e32base.h>
#include <e32hashtab.h>

class CRepository;
class CApaIconCaptionOverrideStore;


/**
 * Read icon and caption details for an app according to the
 * language downgrade path, with ELangNone used as the default
 * language if no better match found.

 @see CApaIconCaptionOverrideStore
 */
NONSHARABLE_CLASS(TApaIconCaptionOverrideReader)
	{
public:
	TApaIconCaptionOverrideReader(const CApaIconCaptionOverrideStore& aStore, const RArray<TLanguage>& aLanguageDowngradePath);
	
	const TDesC* ShortCaption() const;
	const TDesC* Caption() const;
	TBool NumIconsSet() const;
	TInt NumIcons() const;
	const TDesC* IconFileName() const;

private:
	const TDesC* GetString(TUint32 aFieldId) const;
	const TInt* GetInt(TUint32 aFieldId) const;
	
private:
	const CApaIconCaptionOverrideStore& iStore;
	const RArray<TLanguage>& iLanguageDowngradePath;
	};

/**
* Stores the icon and caption overrides for an application.
*/
NONSHARABLE_CLASS(CApaIconCaptionOverridesForApp) : public CBase
	{
public:
	static CApaIconCaptionOverridesForApp* NewL();
	~CApaIconCaptionOverridesForApp();
	CApaIconCaptionOverridesForApp();
	void ConstructL();

	void LoadFromCenRepL(CRepository* aRepository, TUint32 aAppKey);

	TApaIconCaptionOverrideReader Reader(const RArray<TLanguage>& aLanguageDowngradePath) const;
	
private:
	CApaIconCaptionOverrideStore* iStore;
	};


/**
 * Store all of the icon and caption override data indexed by app UID
 */
NONSHARABLE_CLASS(CApaIconCaptionOverrides) : public CBase
	{
public:
	CApaIconCaptionOverrides();
	~CApaIconCaptionOverrides();

	void LoadFromCenRepL();
	void LoadFromCenRepL(CRepository* aRepository);

	CApaIconCaptionOverridesForApp* OverrideForApp(TUid aAppUid) const;
	void SetOverrideForAppL(TUid aAppUid, CApaIconCaptionOverridesForApp* aOverrides);	// takes ownership

private:
	void DeleteOverrides();

private:
	typedef RHashMap<TInt, CApaIconCaptionOverridesForApp*> RAppOverrideMap;
	RAppOverrideMap iMap;
	};
	
/**
* Watches for changes in the Central Repositiory and update the overrides when they occur.
*/
NONSHARABLE_CLASS(CApaIconCaptionCenrepObserver) : public CActive
	{
public:
	static CApaIconCaptionCenrepObserver* NewL(CApaIconCaptionOverrides& aOverrides);
	CApaIconCaptionCenrepObserver(CApaIconCaptionOverrides& aOverrides);
	~CApaIconCaptionCenrepObserver();
	void ConstructL();
	void LoadOverridesL();
	
private:
	void Start();

	void RunL();
	void DoCancel();
	TInt RunError(TInt aError);
	
private:
	CApaIconCaptionOverrides& iOverrides;
	CRepository* iRepository;	// owned
	};


#endif