Collapse all Symbian^3 Product Developer Library

ChspsODT Class Reference

class ChspsODT : public CBase

Class represents an Object Description Tree of HSPS. ODT is cabable of marshaling itself into HBufC8 descriptor and unmarshaling from descriptor stream. A Header is an ODT instance which has not internalized it's resources nor it's DOM (XML payload).

hspsODT.lib

Since: S60 5.0

Inherits from

ChspsODT
- CBase

Public Member Functions
	~ChspsODT()
IMPORT_C void	AddResourceL(ChspsResource *)
TInt	CheckResourceL(ChspsResource *)
IMPORT_C ChspsODT *	CloneL()
IMPORT_C void	CloneL(ChspsODT &)
IMPORT_C TUint	ConfigurationType()
IMPORT_C void	CopyDomDocumentL(ChspsDomDocument &)
IMPORT_C void	DeleteAllResources()
IMPORT_C void	DeleteResourceL(TInt)
IMPORT_C const TDesC &	Description()
IMPORT_C ChspsDomDocument &	DomDocument()
IMPORT_C void	ExternalizeHeaderL(RWriteStream &)
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C void	ExternalizeResourceListL(RWriteStream &)
IMPORT_C TUint32	Family()
IMPORT_C TUint	Flags()
IMPORT_C void	InternalizeHeaderL(RReadStream &)
IMPORT_C void	InternalizeL(RReadStream &)
IMPORT_C void	InternalizeResourceListL(RReadStream &)
IMPORT_C const TDesC &	LogoFile()
IMPORT_C HBufC8 *	MarshalHeaderL()
IMPORT_C TInt	MultiInstance()
IMPORT_C ChspsODT *	NewL()
IMPORT_C ChspsODT *	NewLC(const TDesC8 &)
IMPORT_C TInt	OdtLanguage()
IMPORT_C const TDesC &	PreviewFile()
IMPORT_C const TDesC &	ProviderName()
IMPORT_C TInt	ProviderUid()
IMPORT_C TInt	ResourceCount()
IMPORT_C ChspsResource &	ResourceL(TInt)
IMPORT_C TInt	RootUid()
IMPORT_C void	SetConfigurationType(TUint)
IMPORT_C void	SetDescriptionL(const TDesC &)
IMPORT_C void	SetFamily(const TUint32)
IMPORT_C void	SetFlags(TUint)
IMPORT_C void	SetLogoFileL(const TDesC &)
IMPORT_C void	SetMultiInstance(TInt)
IMPORT_C void	SetOdtLanguage(TInt)
IMPORT_C void	SetPreviewFileL(const TDesC &)
IMPORT_C void	SetProviderNameL(const TDesC &)
IMPORT_C void	SetProviderUid(TInt)
IMPORT_C void	SetRootUid(TInt)
IMPORT_C void	SetThemeFullNameL(const TDesC &)
IMPORT_C void	SetThemeShortNameL(const TDesC &)
IMPORT_C void	SetThemeUid(TInt)
IMPORT_C void	SetThemeVersionL(const TDesC &)
IMPORT_C const TDesC &	ThemeFullName()
IMPORT_C const TDesC &	ThemeShortName()
IMPORT_C TInt	ThemeUid()
IMPORT_C const TDesC &	ThemeVersion()
IMPORT_C void	UnMarshalHeaderL(const TDesC8 &)
IMPORT_C ChspsODT *	UnMarshalHeaderLC(const TDesC8 &)

Private Member Functions
	ChspsODT()
void	ConstructL()
void	CopyODTDataL(const ChspsODT &, ChspsODT &)
TInt	HeaderSize()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
TUint	iConfigurationType
HBufC *	iDescription
ChspsDomDocument *	iDomDocument
TUint32	iFamilyMask
TUint	iFlags
TInt	iLanguage
HBufC *	iLogoFile
TInt	iMultiInstance
HBufC *	iPreviewFile
HBufC *	iProviderName
TUint	iProviderUid
TAny *	iReserved
CArrayPtrSeg< ChspsResource > *	iResourceList
TUint	iRootUid
HBufC *	iThemeFullName
HBufC *	iThemeShortName
TUint	iThemeUid
HBufC *	iThemeVersion

Constructor & Destructor Documentation

ChspsODT()

ChspsODT

(

)

[private]

C++ default constructor.

~ChspsODT()

~ChspsODT

(

)

[virtual]

Destructor.

Member Functions Documentation

AddResourceL(ChspsResource *)

IMPORT_C void

AddResourceL

(

ChspsResource *

aResource

)

Adds a resource-object into ODT.

Since: S60 5.0

Parameters

ChspsResource * aResource

ChspsResource to add. ODT takes ownership.

CheckResourceL(ChspsResource *)

TInt

CheckResourceL

(

ChspsResource *

aResource

)

Checks duplicates.

Since: S60 5.0

Parameters

ChspsResource * aResource

ChspsResource to check.

CloneL()

IMPORT_C ChspsODT *

CloneL

(

)

const

Clones this ChspsODT.

Since: S60 5.0

CloneL(ChspsODT &)

IMPORT_C void

CloneL

(

ChspsODT &

aODT

)

Clones given ODT to this ODT.

Since: S60 5.0

Parameters

ChspsODT & aODT

Source ODT.

ConfigurationType()

IMPORT_C TUint

ConfigurationType

(

)

const

Get configuration type.

Since: S60 5.0

ConstructL()

void

ConstructL

(

)

[private]

By default Symbian 2nd phase constructor is private.

CopyDomDocumentL(ChspsDomDocument &)

IMPORT_C void

CopyDomDocumentL

(

ChspsDomDocument &

aDom

)

Clones the aDom and sets it as this ChspsODT's DomDocument.

Since: S60 5.0

Parameters

ChspsDomDocument & aDom

Dom to be cloned.

CopyODTDataL(const ChspsODT &, ChspsODT &)

void	CopyODTDataL	(	const ChspsODT &	aSource,
			ChspsODT &	aTarget
		)	[private, static]

Helper to ODT cloning. Prevents duplicate code in two clone methods.

Parameters

const ChspsODT & aSource	Source ODT
ChspsODT & aTarget	Target ODT

DeleteAllResources()

IMPORT_C void

DeleteAllResources

(

)

Deletes all resources from the ODT.

Since: S60 5.0

DeleteResourceL(TInt)

IMPORT_C void

DeleteResourceL

(

TInt

aIndex

)

Deletes a resource from the ODT.

Since: S60 5.0

Parameters

TInt aIndex

Index of the resource to be deleted.

Description()

IMPORT_C const TDesC &

Description

(

)

const

Gets description of the widget

Since: S60 5.0

DomDocument()

IMPORT_C ChspsDomDocument &

DomDocument

(

)

const

Get the DomDocument.

Since: S60 5.0

ExternalizeHeaderL(RWriteStream &)

IMPORT_C void

ExternalizeHeaderL

(

RWriteStream &

aStream

)

const

Externalizes the ODT header.

Since: S60 5.0

Parameters

RWriteStream & aStream

The read stream.

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalizes the object.

Since: S60 5.0

Parameters

RWriteStream & aStream

The write stream.

ExternalizeResourceListL(RWriteStream &)

IMPORT_C void

ExternalizeResourceListL

(

RWriteStream &

aStream

)

const

Externalizes the Resource List.

Since: S60 5.0

Parameters

RWriteStream & aStream

The read stream.

Family()

IMPORT_C TUint32

Family

(

)

const

Get family.

Since: S60 5.0

Flags()

IMPORT_C TUint

Flags

(

)

const

Get status flag-definitions for themes.

Since: S60 5.0

HeaderSize()

TInt

HeaderSize

(

)

const [private]

Calculate header size in bytes.

InternalizeHeaderL(RReadStream &)

IMPORT_C void

InternalizeHeaderL

(

RReadStream &

aStream

)

Internalizes the ODT header.

Since: S60 5.0

Parameters

RReadStream & aStream

The read stream.

InternalizeL(RReadStream &)

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

Internalizes the object.

Since: S60 5.0

Parameters

RReadStream & aStream

The read stream.

InternalizeResourceListL(RReadStream &)

IMPORT_C void

InternalizeResourceListL

(

RReadStream &

aStream

)

Internalizes the Resource List.

Since: S60 5.0

Parameters

RReadStream & aStream

The read stream.

LogoFile()

IMPORT_C const TDesC &

LogoFile

(

)

const

Gets path to the logo file

Since: S60 5.0

MarshalHeaderL()

IMPORT_C HBufC8 *

MarshalHeaderL

(

)

const

Marshals the ODT header into descriptor stream.

Since: S60 5.0

MultiInstance()

IMPORT_C TInt

MultiInstance

(

)

const

Get Widget instance count

Since: S60 5.0

NewL()

IMPORT_C ChspsODT *

NewL

(

)

[static]

Two-phased constructor.

Since: S60 5.0

NewLC(const TDesC8 &)

IMPORT_C ChspsODT *

NewLC

(

const TDesC8 &

aStreamData

)

[static]

Two-phased constructor.

Since: S60 5.0

Parameters

const TDesC8 & aStreamData

The read stream.

OdtLanguage()

IMPORT_C TInt

OdtLanguage

(

)

const

Get OdtLanguage.

Since: S60 5.0

PreviewFile()

IMPORT_C const TDesC &

PreviewFile

(

)

const

Gets path to the preview file

Since: S60 5.0

ProviderName()

IMPORT_C const TDesC &

ProviderName

(

)

const

Get ProviderName.

Since: S60 5.0

ProviderUid()

IMPORT_C TInt

ProviderUid

(

)

const

Get ProviderUid

Since: S60 5.0

ResourceCount()

IMPORT_C TInt

ResourceCount

(

)

const

Amount of resources in ODT.

Since: S60 5.0

ResourceL(TInt)

IMPORT_C ChspsResource &

ResourceL

(

TInt

aIndex

)

const

Gets a resource.

Since: S60 5.0

Parameters

TInt aIndex

Index of the resource to be retrieved.

RootUid()

IMPORT_C TInt

RootUid

(

)

const

Get RootUid.

Since: S60 5.0

SetConfigurationType(TUint)

IMPORT_C void

SetConfigurationType

(

TUint

aType

)

Set configurationt type.

Since: S60 5.0

Parameters

TUint aType

Type.

SetDescriptionL(const TDesC &)

IMPORT_C void

SetDescriptionL

(

const TDesC &

aDesc

)

Sets description of the widget

Since: S60 5.0

Parameters

const TDesC & aDesc

Text

SetFamily(const TUint32)

IMPORT_C void

SetFamily

(

const TUint32

aFamilyMask

)

Set family. Identifies the resolution and user interface for which the resource/widget was designed for (e.g. vga, qhd_tch).

Since: S60 5.0

Parameters

const TUint32 aFamilyMask

SetFlags(TUint)

IMPORT_C void

SetFlags

(

TUint

aFlags

)

Set status flag-definitions for themes.

Since: S60 5.0

Parameters

TUint aFlags

Flags to be set.

SetLogoFileL(const TDesC &)

IMPORT_C void

SetLogoFileL

(

const TDesC &

aPath

)

Sets path of the logo file

Since: S60 5.0

Parameters

const TDesC & aPath

Path to the file

SetMultiInstance(TInt)

IMPORT_C void

SetMultiInstance

(

TInt

aMultiInstance

)

Set Widget instance count

Since: S60 5.0

Parameters

TInt aMultiInstance

multiinstance.

SetOdtLanguage(TInt)

IMPORT_C void

SetOdtLanguage

(

TInt

aLanguage

)

Set OdtLanguage.

Since: S60 5.0

Parameters

TInt aLanguage

Themes' language.

SetPreviewFileL(const TDesC &)

IMPORT_C void

SetPreviewFileL

(

const TDesC &

aPath

)

Sets path of the preview file

Since: S60 5.0

Parameters

const TDesC & aPath

Path to the file

SetProviderNameL(const TDesC &)

IMPORT_C void

SetProviderNameL

(

const TDesC &

aName

)

Set ProviderName.

Since: S60 5.0

Parameters

const TDesC & aName

The name of the theme provider.

SetProviderUid(TInt)

IMPORT_C void

SetProviderUid

(

TInt

aUid

)

Set providerUid.

Since: S60 5.0

Parameters

TInt aUid

The UID of the theme provider.

SetRootUid(TInt)

IMPORT_C void

SetRootUid

(

TInt

aUid

)

Set Uid of the application or interface, which uses the theme.

Since: S60 5.0

Parameters

TInt aUid

The root UID.

SetThemeFullNameL(const TDesC &)

IMPORT_C void

SetThemeFullNameL

(

const TDesC &

aName

)

Set ThemeFullName.

Since: S60 5.0

Parameters

const TDesC & aName

Themes' name.

SetThemeShortNameL(const TDesC &)

IMPORT_C void

SetThemeShortNameL

(

const TDesC &

aName

)

Set ThemeShortName.

Since: S60 5.0

Parameters

const TDesC & aName

Themes' short name.

SetThemeUid(TInt)

IMPORT_C void

SetThemeUid

(

TInt

aUid

)

Set ThemeUid.

Since: S60 5.0

Parameters

TInt aUid

Theme UID.

SetThemeVersionL(const TDesC &)

IMPORT_C void

SetThemeVersionL

(

const TDesC &

aVersion

)

Set ThemeVersion.

Since: S60 5.0

Parameters

const TDesC & aVersion

Themes' version.

ThemeFullName()

IMPORT_C const TDesC &

ThemeFullName

(

)

const

Get ThemeFullName.

Since: S60 5.0

ThemeShortName()

IMPORT_C const TDesC &

ThemeShortName

(

)

const

Get ThemeShortName

Since: S60 5.0

ThemeUid()

IMPORT_C TInt

ThemeUid

(

)

const

Get ThemeUid.

Since: S60 5.0

ThemeVersion()

IMPORT_C const TDesC &

ThemeVersion

(

)

const

Get ThemeVersion.

Since: S60 5.0

UnMarshalHeaderL(const TDesC8 &)

IMPORT_C void

UnMarshalHeaderL

(

const TDesC8 &

aStreamData

)

Unmarshals the header information from the stream and saves the data into same instance.

Since: S60 5.0

Parameters

const TDesC8 & aStreamData

Descriptor stream containing the ODT header data.

UnMarshalHeaderLC(const TDesC8 &)

IMPORT_C ChspsODT *

UnMarshalHeaderLC

(

const TDesC8 &

aStreamData

)

[static]

Unmarshals the header information from the stream and returns ODT instance.

Since: S60 5.0

HBufC * iThemeVersion

HBufC *

iThemeVersion

[private]