/*
* Copyright (c) 2004-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:
* Definition of the Swi::Sis::CLanguage
*
*/
/**
@file
@released
@internalTechnology
*/
#ifndef __SISLANGUAGE_H__
#define __SISLANGUAGE_H__
#include <e32base.h>
#include "sisfield.h"
namespace Swi
{
namespace Sis
{
class TPtrProvider;
/**
* This class represents a SISLanguage. SISLanguage is a basic structure found in SIS files.
* It is described in SGL.GT0188.251.
*
* @released
* @internalTechnology
*/
class CLanguage : public CField
{
public:
/**
* This creates a new CLanguage object.
*
* @param aDataProvider An instance of a MSisDataProvider to read the entity from.
* @param aTypeReadBehaviour Whether we need to check the sis type or not.
*
* @return An instance of CLanguage representing the data read.
*/
IMPORT_C static CLanguage* NewL(MSisDataProvider& aDataProvider, TInt64& aBytesRead, TReadTypeBehaviour aTypeReadBehaviour = EReadType);
/**
* This creates a new CLanguage object and places it on the cleanup stack.
*
* @param aDataProvider An instance of a MSisDataProvider to read the entity from.
* @param aTypeReadBehaviour Whether we need to check the sis type or not.
*
* @return An instance of CLanguage representing the data read.
*/
IMPORT_C static CLanguage* NewLC(MSisDataProvider& aDataProvider, TInt64& aBytesRead, TReadTypeBehaviour aTypeReadBehaviour = EReadType);
/**
* This creates a new CLanguage object in place.
*
* @param aDataProvider An instance of a TPtrProvider to read the entity from.
* @param aTypeReadBehaviour Whether we need to check the sis type or not.
*
* @return An instance of CLanguage representing the data read.
*/
IMPORT_C static CLanguage* NewL(TPtrProvider& aDataProvider, TInt64& aBytesRead, TReadTypeBehaviour aTypeReadBehaviour = EReadType);
/**
* This creates a new CLanguage object in place and places it on the cleanup stack.
*
* @param aDataProvider An instance of a TPtrProvider to read the entity from.
* @param aTypeReadBehaviour Whether we need to check the sis type or not.
*
* @return An instance of CLanguage representing the data read.
*/
IMPORT_C static CLanguage* NewLC(TPtrProvider& aDataProvider, TInt64& aBytesRead, TReadTypeBehaviour aTypeReadBehaviour = EReadType);
IMPORT_C virtual ~CLanguage();
/**
* This function returns the language.
*/
inline TLanguage Language() const;
private:
CLanguage();
/**
* The second-phase constructor.
*
* @param aDataProvider An instance of a MSisDataProvider to read the entity from.
* @param aTypeReadBehaviour Whether we need to check the sis type or not.
*/
void ConstructL(MSisDataProvider& aDataProvider, TInt64& aBytesRead, TReadTypeBehaviour aTypeReadBehaviour);
/**
* The second-phase in-place constructor.
*
* @param aDataProvider An instance of a MSisDataProvider to read the entity from.
* @param aTypeReadBehaviour Whether we need to check the sis type or not.
*/
void ConstructL(TPtrProvider& aDataProvider, TInt64& aBytesRead, TReadTypeBehaviour aTypeReadBehaviour);
private:
/**
* The language.
*/
TLanguage iLanguage;
};
// inline functions
TLanguage CLanguage::Language() const
{
return iLanguage;
}
} // namespace Sis
} // namespace Swi
#endif