CContactItemViewDef Class Reference

#include <app/cntdb.h>

class CContactItemViewDef : public CBase, public CBase

Inherits from

CContactItemViewDef
- CBase
- CBase

Public Member Enumerations
enum	TMode { EIncludeHiddenFields, EMaskHiddenFields }
enum	TUse { EIncludeFields, EMaskFields }

Public Member Functions
IMPORT_C void	AddL(TFieldType)
IMPORT_C TBool	Contains(const CContactItem &)
TInt	Count()
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C TInt	Find(const CContentType &)
IMPORT_C TInt	Find(TFieldType)
IMPORT_C void	InternalizeL(RReadStream &)
IMPORT_C TBool	MatchesAll()
TMode	Mode()
IMPORT_C CContactItemViewDef *	NewL(TUse, TMode)
IMPORT_C CContactItemViewDef *	NewLC(TUse, TMode)
CContactItemViewDef *	NewLC(RReadStream &)
IMPORT_C void	Remove(TFieldType)
IMPORT_C void	Remove(TInt)
void	Reset()
void	SetMode(TMode)
void	SetUse(TUse)
TUse	Use()
TUid	operator[](TInt)

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

A view definition for a contact item.

When reading or opening a contact item using the CContactDatabase class, a view definition may be specified to indicate which field data should be retrieved. See for instance CContactDatabase::ReadContactL().

A view definition for a contact item contains an array of field types, a use (CContactItemViewDef::TUse) and a mode (CContactItemViewDef::TMode). The use indicates whether the field types contained in the view definition should be included in or excluded from the view. The mode indicates whether fields with the hidden attribute should be included or excluded.

Member Enumeration Documentation

Enum TMode

Include or exclude hidden fields.

Enumerator	Value	Description
EIncludeHiddenFields		Include hidden fields in the view.
EMaskHiddenFields		Exclude hidden fields from the view.

Enum TUse

Include or exclude specified fields.

Enumerator	Value	Description
EIncludeFields		Include specified fields in the view.
EMaskFields		Exclude specified fields from the view.

Member Function Documentation

AddL ( TFieldType )

IMPORT_C void

AddL

(

TFieldType

aFieldType

)

Appends a field type to the view definition's array of field types.

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

Contains ( const CContactItem & )

IMPORT_C TBool

Contains

(

const CContactItem &

aItem

)

Tests whether a contact item complies with the view definition.

This indicates whether or not the item will be included in the view.

Parameters
aItem	The contact item to test.

Return Value: ETrue if any of the item's fields are contained in the view definition (so that the item will be included in the view), EFalse if none of the item's fields are contained in the view definition (so that the item will not be included in the view).

Count ( )

TInt

Count

(

)

const [inline]

Gets the number of field types in the view definition.

Return Value: The number of field types in the view definition.

ExternalizeL ( RWriteStream & )

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalises the item view definition to a write stream. The presence of this function means that the standard templated operator<<() (defined in s32strm.h) is available to externalise objects of this class.

Parameters
aStream	Stream to which the item view definition should be externalised.

Find ( const CContentType & )

IMPORT_C TInt

Find

(

const CContentType &

aContentType

)

const

Searches the view definition for any field type contained in the specified content type.

Parameters
aContentType	Content type containing the field types to search for.

Return Value: The index in the view definition of the first matching field type or KErrNotFound.

Find ( TFieldType )

IMPORT_C TInt

Find

(

TFieldType

aFieldType

)

const

Searches the view definition for the specified field type.

Parameters
aFieldType	The field type to search for.

Return Value: The index in the view definition of the matching field type, or KErrNotFound.

InternalizeL ( RReadStream & )

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

Internalises the item view definition from a read stream. The presence of this function means that the standard templated operator>>() (defined in s32strm.h) is available to internalise objects of this class.

Parameters
aStream	Stream from which the item view definition should be internalised.

MatchesAll ( )

IMPORT_C TBool

MatchesAll

(

)

const

Tests whether the view definition contains a field type with the value KUidContactFieldMatchAll.

If this is the case, all fields in the contact item are retrieved, regardless of the other field types specified in the view definition.

Return Value: ETrue if all field types are matched, EFalse if not.

Mode ( )

TMode

Mode

(

)

const [inline]

Gets the view definition's mode.

Return Value: The current TMode setting.

NewL ( TUse, TMode )

IMPORT_C CContactItemViewDef *	NewL	(	TUse	aUse,
			TMode	aMode
		)	[static]

Allocates and constructs a new CContactItemViewDef, with a use and a mode.

Parameters
aUse	Specifies whether to include or exclude specified fields.
aMode	Specifies whether to include or exclude hidden fields.

Return Value: Pointer to the newly created view definition.

NewLC ( TUse, TMode )

IMPORT_C CContactItemViewDef *	NewLC	(	TUse	aUse,
			TMode	aMode
		)	[static]

Allocates and constructs a new CContactItemViewDef, specifying a use and a mode, leaving the object on the cleanup stack.

Parameters
aUse	Specifies whether to include or exclude specified fields.
aMode	Specifies whether to include or exclude hidden fields.

Return Value: Pointer to the newly created view definition.

NewLC ( RReadStream & )

CContactItemViewDef *

NewLC

(

RReadStream &

aStream

)

[static]

Allocates and constructs a new CContactItemViewDef based on a RReadStream, specifying a use and a mode, leaving the object on the cleanup stack.

Parameters
aStream	RReadStream containing object to internalize.

Return Value: Pointer to the newly created view definition.

Remove ( TFieldType )

IMPORT_C void

Remove

(

TFieldType

aFieldType

)

Removes a field type, identified by its UID.

Parameters
aFieldType	The field type to remove from the list. This must be present in the CContactItemViewDef object, or the function raises a panic.

Remove ( TInt )

IMPORT_C void

Remove

(

TInt

aIndex

)

Removes a field type, identified by its index into the array of field types.

Parameters
aIndex	The index of the element to delete. The position is relative to zero. This value must not be negative and must not be greater than the number of elements currently in the list, or the function raises a panic.

Reset ( )

void

Reset

(

)

[inline]

Deletes all field types from the view definition's field type array.

SetMode ( TMode )

void

SetMode

(

TMode

aMode

)

[inline]

Sets the view definition's mode.

Parameters
aMode	The new TMode setting.

SetUse ( TUse )

void

SetUse

(

TUse

aUse

)

[inline]

Sets the view definition's use.

Parameters
aUse	The new TUse setting.

Use ( )

TUse

Use

(

)

const [inline]

Gets the view definition's use.

Return Value: The current TUse setting.

operator[] ( TInt )

TUid

operator[]

(

TInt

aIndex

)

const [inline]

Gets the field type located at a specified index position within the field type array.

Parameters
aIndex	The position of the field type in the array, relative to zero. It must be non-negative and less than the number of objects in the array otherwise the function raises a panic.

Return Value: The field type located at index aIndex within the array (this is equivalent to a TFieldType).