Symbian^3 Application Developer Library >

CBTServiceParameterList Class Reference

class CBTServiceParameterList : public CBase

A class holding paths to different types of files.

In case of an XHTML file the list collects paths to objects referenced in the file.

In case of an image the list resolves the MIME types and displayable names of the images.

BtServiceUtils.lib
Since
Series 60 2.6

Inherits from

Public Member Functions
~CBTServiceParameterList ()
IMPORT_C void AddImageL (const TDesC &)
IMPORT_C void AddImageL ( RFile )
IMPORT_C void AddObjectL (const TDesC &)
IMPORT_C void AddObjectL ( RFile )
IMPORT_C void AddXhtmlL (const TDesC &)
TBool HasAnyReferencedObjects ()
TBTSUImageParam ImageAtL ( TInt )
TInt ImageCount ()
TInt ImageListSize ()
void MarkAsSendL ( TInt )
IMPORT_C CBTServiceParameterList * NewL ()
IMPORT_C CBTServiceParameterList * NewLC ()
RFile & ObjectAtL ( TInt )
TInt ObjectCount ()
TInt ObjectListSizeL ()
void RemoveImageL ( TInt )
TInt RemovedImageCount ()
void ResetImageHandleL ( TInt )
void ResetObjectHandleL ( TInt )
TBTSUXhtmlParam XhtmlAt ( TInt )
TInt XhtmlCount ()
Private Member Functions
CBTServiceParameterList ()
void ConstructL ()
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
RFs iFileSession
RArray < TBTSUImageParam > iImageList
RArray < RFile > iObjectList
TInt iRemovedImageCount
RArray < TBTSUXhtmlParam > iXhtmlList

Constructor & Destructor Documentation

CBTServiceParameterList()

CBTServiceParameterList ( ) [private]

C++ default constructor.

~CBTServiceParameterList()

~CBTServiceParameterList ( ) [virtual]

Destructor.

Member Functions Documentation

AddImageL(const TDesC &)

IMPORT_C void AddImageL ( const TDesC & aFilePath )
Adds an image file path to the list.
Since
Series 60 2.6

Parameters

const TDesC & aFilePath A full path and file name.

AddImageL(RFile)

IMPORT_C void AddImageL ( RFile aFile )
Adds an image file path to the list.
Since
Series 60 2.6

Parameters

RFile aFile file handle to be send.

AddObjectL(const TDesC &)

IMPORT_C void AddObjectL ( const TDesC & aFilePath )
Adds an object file path to the list.
Since
Series 60 2.6

Parameters

const TDesC & aFilePath A full path and file name.

AddObjectL(RFile)

IMPORT_C void AddObjectL ( RFile aFile )
Adds an object file path to the list.
Since
Series 60 2.6

Parameters

RFile aFile file handle to be send .

AddXhtmlL(const TDesC &)

IMPORT_C void AddXhtmlL ( const TDesC & aFilePath )
Adds an xhtml file path to the list.
Since
Series 60 2.6

Parameters

const TDesC & aFilePath A full path and file name.

ConstructL()

void ConstructL ( ) [private]

By default Symbian 2nd phase constructor is private.

HasAnyReferencedObjects()

TBool HasAnyReferencedObjects ( ) const

Checks whether the list has any xhtml-files with referenced objects.

ImageAtL(TInt)

TBTSUImageParam ImageAtL ( TInt aIndex ) const

Returns a copy of an element of the list from the given index.

Parameters

TInt aIndex The index.

ImageCount()

TInt ImageCount ( ) const

Return the number of image file paths in the list.

ImageListSize()

TInt ImageListSize ( ) const

Return the size of images in the list.

MarkAsSendL(TInt)

void MarkAsSendL ( TInt aIndex )

Reset image filehandle

Parameters

TInt aIndex The index.

NewL()

IMPORT_C CBTServiceParameterList * NewL ( ) [static]

Two-phased constructor.

NewLC()

IMPORT_C CBTServiceParameterList * NewLC ( ) [static]

ObjectAtL(TInt)

RFile & ObjectAtL ( TInt aIndex )

Returns a copy of an element of the list from the given index.

Parameters

TInt aIndex The index.

ObjectCount()

TInt ObjectCount ( ) const

Return the number of object file paths in the list.

ObjectListSizeL()

TInt ObjectListSizeL ( ) const

Return the size of objects in the list.

RemoveImageL(TInt)

void RemoveImageL ( TInt aIndex )

Remove image from list.

Parameters

TInt aIndex The index.

RemovedImageCount()

TInt RemovedImageCount ( )

Return count of removed image

ResetImageHandleL(TInt)

void ResetImageHandleL ( TInt aIndex )

Reset image filehandle

Parameters

TInt aIndex The index.

ResetObjectHandleL(TInt)

void ResetObjectHandleL ( TInt aIndex )

Reset object filehandle

Parameters

TInt aIndex The index.

XhtmlAt(TInt)

TBTSUXhtmlParam XhtmlAt ( TInt aIndex ) const

Returns a copy of an element of the list from the given index.

Parameters

TInt aIndex The index.

XhtmlCount()

TInt XhtmlCount ( ) const

Return the number of xhtml file paths in the list.

Member Data Documentation

RFs iFileSession

RFs iFileSession [private]

RArray< TBTSUImageParam > iImageList

RArray < TBTSUImageParam > iImageList [private]

RArray< RFile > iObjectList

RArray < RFile > iObjectList [private]

TInt iRemovedImageCount

TInt iRemovedImageCount [private]

RArray< TBTSUXhtmlParam > iXhtmlList

RArray < TBTSUXhtmlParam > iXhtmlList [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.