Collapse all Symbian^3 Product Developer Library

CPbk2StoreProperty Class Reference

class CPbk2StoreProperty : public CBase

Phonebook 2 contact store property. Responsible for presenting contact store related information.

Inherits from

CPbk2StoreProperty
- CBase

Public Member Functions
	~CPbk2StoreProperty()
IMPORT_C void	AppendViewDefinitionL(CPbk2StoreViewDefinition *)
IMPORT_C MPbk2FieldPropertyArray *	CreateStoreSpecificFieldPropertiesL(const MVPbkFieldTypeList &)
IMPORT_C TInt	FieldPropertiesResId()
IMPORT_C const CPbk2StoreViewDefinition *	FindView(TPbk2ContactViewType)
IMPORT_C TUint32	Flags()
IMPORT_C TUint32	MemoryInfoTypes()
IMPORT_C CPbk2StoreProperty *	NewL()
IMPORT_C CPbk2StoreProperty *	NewLC(TResourceReader &)
IMPORT_C CPbk2StoreProperty *	NewLC(const CPbk2StoreProperty &)
IMPORT_C CPbk2Content *	RetrieveContentLC(TPbk2ContentId)
IMPORT_C void	SetFieldPropertiesResId(TInt)
IMPORT_C void	SetFlags(TUint32)
IMPORT_C void	SetMemoryInfoTypes(TUint32)
IMPORT_C void	SetStoreNameL(const TDesC &)
IMPORT_C void	SetStoreUriL(const TDesC &)
IMPORT_C const TDesC &	StoreName()
IMPORT_C TVPbkContactStoreUriPtr	StoreUri()
IMPORT_C TArray< const CPbk2StoreViewDefinition * >	Views()

Private Member Functions
	CPbk2StoreProperty()
void	ConstructFieldPropertiesL(TInt)
void	ConstructL(TResourceReader &)
void	ConstructL(const CPbk2StoreProperty &)
void	CreateLocalizedTextsL(const CPbk2StoreProperty &)

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
TInt	iFieldPropertiesResId
TUint32	iFlags
RPointerArray< const CPbk2LocalizedText >	iLocalizedTexts
TUint32	iMemoryInfoTypes
HBufC *	iStoreName
HBufC *	iStoreUri
RPointerArray< const CPbk2StoreViewDefinition >	iStoreViews

Constructor & Destructor Documentation

CPbk2StoreProperty()

CPbk2StoreProperty

(

)

[private]

~CPbk2StoreProperty()

~CPbk2StoreProperty

(

)

Destructor

Member Functions Documentation

AppendViewDefinitionL(CPbk2StoreViewDefinition *)

IMPORT_C void

AppendViewDefinitionL

(

CPbk2StoreViewDefinition *

aViewDefinition

)

Appends a new view definition.

Parameters

CPbk2StoreViewDefinition * aViewDefinition

View definition to append. Ownership changes. Client must release the ownership after the call.

ConstructFieldPropertiesL(TInt)

void

ConstructFieldPropertiesL

(

TInt

aFieldPropertyArrayResId

)

[private]

Parameters

TInt aFieldPropertyArrayResId

ConstructL(TResourceReader &)

void

ConstructL

(

TResourceReader &

aReader

)

[private]

Parameters

TResourceReader & aReader

ConstructL(const CPbk2StoreProperty &)

void

ConstructL

(

const CPbk2StoreProperty &

aProperty

)

[private]

Parameters

const CPbk2StoreProperty & aProperty

CreateLocalizedTextsL(const CPbk2StoreProperty &)

void

CreateLocalizedTextsL

(

const CPbk2StoreProperty &

aProperty

)

[private]

Parameters

const CPbk2StoreProperty & aProperty

CreateStoreSpecificFieldPropertiesL(const MVPbkFieldTypeList &)

IMPORT_C MPbk2FieldPropertyArray *

CreateStoreSpecificFieldPropertiesL

(

const MVPbkFieldTypeList &

aFieldTypeList

)

const

Returns the store specific field properties. The store property contains a link to the field property array. If the field property resource has been defined then those properties are returned. The related field types must be given to create properties because each property links to one single field type.

Parameters

const MVPbkFieldTypeList & aFieldTypeList

In most cases this is the Virtual Phonebook master field type list because it contains all the field types.

FieldPropertiesResId()

IMPORT_C TInt

FieldPropertiesResId

(

)

const

Returns the resource id of the store's field property array.

PHONEBOOK2_FIELD_PROPERTY_ARRAY

FindView(TPbk2ContactViewType)

IMPORT_C const CPbk2StoreViewDefinition *

FindView

(

TPbk2ContactViewType

aViewType

)

const

Finds the view definitions from the property.

TPbk2ContactViewType

Parameters

TPbk2ContactViewType aViewType

View type.

Flags()

IMPORT_C TUint32

Flags

(

)

const

Returns store property flags.

Pbk2StoreProperty.hrh

MemoryInfoTypes()

IMPORT_C TUint32

MemoryInfoTypes

(

)

const

Returns a set of info types that define what information is requested from the store's MVPbkContactStoreInfo interface.

Pbk2StoreProperty.hrh

NewL()

IMPORT_C CPbk2StoreProperty *

NewL

(

)

[static]

Creates a new instance of this class.

NewLC(TResourceReader &)

IMPORT_C CPbk2StoreProperty *

NewLC

(

TResourceReader &

aReader

)

[static]

Creates a new instance of this class.

PHONEBOOK2_STORE_PROPERTY

Parameters

TResourceReader & aReader

Resource reader pointed to a PHONEBOOK2_STORE_PROPERTY resource.

NewLC(const CPbk2StoreProperty &)

IMPORT_C CPbk2StoreProperty *

NewLC

(

const CPbk2StoreProperty &

aProperty

)

[static]

Creates a new instance of this class.

Parameters

const CPbk2StoreProperty & aProperty

An existing store property.

RetrieveContentLC(TPbk2ContentId)

IMPORT_C CPbk2Content *

RetrieveContentLC

(

TPbk2ContentId

aContext

)

const

Returns a content object that is mapped to the requested context. Ownership of the returned object is passed. The client is able to acquire content to a certain context using this method. The client can pass information of the context to the content generation implementation. The client is then responsible for finding the contents type dynamically.

Parameters

TPbk2ContentId aContext

Identifier of the context of the query.

SetFieldPropertiesResId(TInt)

IMPORT_C void

SetFieldPropertiesResId

(

TInt

aFieldPropertiesResId

)

Sets the store specific field property array resource id.

Parameters

TInt aFieldPropertiesResId

Resource id of a PHONEBOOK2_FIELD_PROPERTY_ARRAY resource.

SetFlags(TUint32)

IMPORT_C void

SetFlags

(

TUint32

aFlags

)

Sets the store property flags. Overwrites existing flags.

Pbk2StoreProperty.hrh

Parameters

TUint32 aFlags

Store property flags to set.

SetMemoryInfoTypes(TUint32)

IMPORT_C void

SetMemoryInfoTypes

(

TUint32

aInfoTypes

)

Sets the info types that define which data is requested from the MVPbkContactStoreInfo interface.

Pbk2StoreProperty.hrh

Parameters

TUint32 aInfoTypes

Memory info types.

SetStoreNameL(const TDesC &)

IMPORT_C void

SetStoreNameL

(

const TDesC &

aStoreName

)

Sets the name for the store. The name is used in the UI.

Parameters

const TDesC & aStoreName

Name for the store.

SetStoreUriL(const TDesC &)

IMPORT_C void

SetStoreUriL

(

const TDesC &

aStoreUri

)

Sets the store URI for the property.

Parameters

const TDesC & aStoreUri

The URI that is used to load the store from the Virtual Phonebook.

StoreName()

IMPORT_C const TDesC &

StoreName

(

)

const

Returns the name of the store.

StoreUri()

IMPORT_C TVPbkContactStoreUriPtr

StoreUri

(

)

const

Returns the store URI of the property.

Views()

IMPORT_C TArray< const CPbk2StoreViewDefinition * >

Views

(

)

const

Returns an array of view definitions for the store.

Member Data Documentation

TInt iFieldPropertiesResId

TInt

iFieldPropertiesResId

[private]

TUint32 iFlags

TUint32

iFlags

[private]

RPointerArray< const CPbk2LocalizedText > iLocalizedTexts

RPointerArray< const CPbk2LocalizedText >

iLocalizedTexts

[private]

TUint32 iMemoryInfoTypes

TUint32

iMemoryInfoTypes

[private]

HBufC * iStoreName

HBufC *

iStoreName

[private]

HBufC * iStoreUri

HBufC *

iStoreUri

[private]

RPointerArray< const CPbk2StoreViewDefinition > iStoreViews

RPointerArray< const CPbk2StoreViewDefinition >

iStoreViews

[private]