Collapse all Symbian^3 Application Developer Library

ContentAccess::RAttributeSet Class Reference

class ContentAccess::RAttributeSet

Holds the values of a predefined set of attributes based upon ContentAccess::TAttribute

It is also possible for an agent to provide an extended set of these attributes beyond EAgentSpecificAttributeBase but only applications written to support that particular agent will support this.

No duplicate attributes are allowed in the set

Nested Classes and Structures

ContentAccess::RAttributeSet::TAttributeValue

Public Member Functions
	RAttributeSet ()
IMPORT_C void	AddL ( TInt )
IMPORT_C void	Close ()
IMPORT_C TInt	Count ()
IMPORT_C void	ExternalizeL ( RWriteStream &)
IMPORT_C TInt	GetValue ( TInt , TInt &)
IMPORT_C void	InternalizeL ( RReadStream &)
IMPORT_C TInt	SetValue ( TInt , TInt , TInt )
IMPORT_C TInt	operator[] ( TInt )

Private Member Functions
void	AddL ( TInt , TInt , TInt )

Private Attributes
RArray < TAttributeValue >	iAttributes

Constructor & Destructor Documentation

RAttributeSet()

IMPORT_C

RAttributeSet

(

)

Member Functions Documentation

AddL(TInt)

IMPORT_C void

AddL

(

TInt

aAttribute

)

Add a new attribute to the set The attribute is initalised with a default value of EAttributeNotSupported

Parameters

TInt aAttribute

The attribute to add to the set

AddL(TInt, TInt, TInt)

void	AddL	(	TInt	aAttribute,
			TInt	aValue,
			TInt	aErrorCode
		)	[private]

Parameters

TInt aAttribute
TInt aValue
TInt aErrorCode

Close()

IMPORT_C void

(

)

Release all resources used by the RAttributeSet

This must be called before the RAttribute set goes out of scope

Count()

IMPORT_C TInt

Count

(

)

const

The number of attributes in the set

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Write the RAttributeSet to a stream

Parameters

RWriteStream & aStream

The stream to write the attribute set to

GetValue(TInt, TInt &)

IMPORT_C TInt	GetValue	(	TInt	aAttribute,
			TInt &	aValue
		)	const

Get the value of a specified attribute

Parameters

TInt aAttribute	The attribute to query
TInt & aValue	The value of the attribute

InternalizeL(RReadStream &)

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

Read the RAttributeSet from a stream This does not clear the contents of the attribute set before reading. The values of any attributes already in the set are updated with new values from the stream. New attributes from the stream and their values are added to the set.

Parameters

RReadStream & aStream

The stream to read the attribute set from

SetValue(TInt, TInt, TInt)

IMPORT_C TInt	SetValue	(	TInt	aAttribute,
			TInt	aValue,
			TInt	aErrorCode
		)

Set the value of an attribute within the set

Parameters

TInt aAttribute	The attribute to set
TInt aValue	The value of the attribute
TInt aErrorCode	The error code to return when this attribute is requested via the GetValue() function

operator[](TInt)

IMPORT_C TInt

operator[]

(

TInt

aIndex

)

const

Find the attribute stored at a particular index in the set

Parameters

TInt aIndex

The index of the attribute

Member Data Documentation

RArray< TAttributeValue > iAttributes

RArray < TAttributeValue >

iAttributes

[private]