CContactViewDef Class Reference

#include <app/cntdb.h>

class CContactViewDef : public CBase, public CBase

Inherits from

CContactViewDef
- CBase
- CBase

Public Member Functions
	~CContactViewDef()
void	AddL(TFieldType)
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C CContactIdArray &	Groups()
IMPORT_C void	InternalizeL(RReadStream &)
IMPORT_C CContactItemViewDef &	ItemDef()
IMPORT_C CContactViewDef *	NewL()
IMPORT_C CContactViewDef *	NewL(CContactItemViewDef *)
IMPORT_C CContactViewDef *	NewLC()
IMPORT_C CContactViewDef *	NewLC(CContactItemViewDef *)
CContactViewDef *	NewLC(RReadStream &)

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()

Detailed Description

Specifies a subset of fields to be loaded when reading a contact item.

A default view definition is owned by the contact database. It is set using CContactDatabase::SetViewDefinitionL() and is used in calls to CContactDatabase::ReadContactL(), ReadContactLC() and ReadContactAndAgentL() when no view definition is specified.

The view definition owns the item view definition (see the CContactItemViewDef class), which stores the view definition's field types, use and mode.

The following functions declared in class CContactViewDef have not been implemented:- Groups(), AddL().

Constructor & Destructor Documentation

~CContactViewDef ( )

IMPORT_C

~CContactViewDef

(

)

Destroys the view definition object and deletes its owned item view definition.

Member Function Documentation

AddL ( TFieldType )

void

AddL

(

TFieldType

aFieldType

)

[inline]

This function is not implemented.

Parameters
aFieldType	The field type to append to the array of field types.

ExternalizeL ( RWriteStream & )

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalises the object's item view definition to a write stream.

Parameters
aStream	Stream to which the object should be externalised.

Groups ( )

IMPORT_C CContactIdArray &

Groups

(

)

const

This function is not implemented

This function is not supported.

If called, it leaves with KErrNotSupported.

InternalizeL ( RReadStream & )

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

Internalises the object's item view definition from a read stream.

Parameters
aStream	Stream from which the object should be internalised.

ItemDef ( )

IMPORT_C CContactItemViewDef &

ItemDef

(

)

const

Gets the object's item view definition.

Return Value: Reference to the item view definition.

NewL ( )

IMPORT_C CContactViewDef *

NewL

(

)

[static]

Allocates and constructs a view definition.

Return Value: Pointer to the new view definition.

NewL ( CContactItemViewDef * )

IMPORT_C CContactViewDef *

NewL

(

CContactItemViewDef *

aItemDef

)

[static]

Allocates and constructs a view definition.

Parameters
aItemDef	Pointer to the item view definition. This contains the view definition's field types, use and mode. The view definition takes ownership of this.

Return Value: Pointer to the new view definition.

NewLC ( )

IMPORT_C CContactViewDef *

NewLC

(

)

[static]

Allocates and constructs a view definition, leaving it on the cleanup stack.

Return Value: Pointer to the new view definition.

NewLC ( CContactItemViewDef * )

IMPORT_C CContactViewDef *

NewLC

(

CContactItemViewDef *

aItemDef

)

[static]

Allocates and constructs a view definition.

Parameters
aItemDef	Pointer to the item view definition. This contains the view definition's field types, use and mode. The view definition takes ownership of this.

Return Value: Pointer to the new view definition. This is left on the cleanup stack.

NewLC ( RReadStream & )

CContactViewDef *

NewLC

(

RReadStream &

aStream

)

[static]

Allocates and constructs a view definition based on a RReadStream.

Parameters
aStream	RReadStream containing object to internalize.

Return Value: Pointer to the new view definition. This is left on the cleanup stack.