ContentAccess::RAttributeSet Class Reference

#include <caf/attributeset.h>

Link against: cafutils.lib

class ContentAccess::RAttributeSet
Public Member Functions
RAttributeSet()
IMPORT_C voidAddL(TInt)
IMPORT_C voidClose()
IMPORT_C TIntCount()
IMPORT_C voidExternalizeL(RWriteStream &)
IMPORT_C TIntGetValue(TInt, TInt &)
IMPORT_C voidInternalizeL(RReadStream &)
IMPORT_C TIntSetValue(TInt, TInt, TInt)
IMPORT_C TIntoperator[](TInt)

Detailed Description

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

Constructor & Destructor Documentation

RAttributeSet ( )

IMPORT_CRAttributeSet()

Member Function Documentation

AddL ( TInt )

IMPORT_C voidAddL(TIntaAttribute)

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

Parameters
aAttributeThe attribute to add to the set

Close ( )

IMPORT_C voidClose()

Release all resources used by the RAttributeSet

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

Count ( )

IMPORT_C TIntCount()const

The number of attributes in the set

Return Value
The number of attributes in the set

ExternalizeL ( RWriteStream & )

IMPORT_C voidExternalizeL(RWriteStream &aStream)const

Write the RAttributeSet to a stream

Parameters
aStreamThe stream to write the attribute set to

GetValue ( TInt, TInt & )

IMPORT_C TIntGetValue(TIntaAttribute,
TInt &aValue
)const

Get the value of a specified attribute

Parameters
aAttributeThe attribute to query
aValueThe value of the attribute
Return Value
Whether the value parameter was updated KErrNone The attribute value was updated KErrNotFound The attribute is not part of the set

InternalizeL ( RReadStream & )

IMPORT_C voidInternalizeL(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
aStreamThe stream to read the attribute set from

SetValue ( TInt, TInt, TInt )

IMPORT_C TIntSetValue(TIntaAttribute,
TIntaValue,
TIntaErrorCode
)

Set the value of an attribute within the set

Parameters
aAttributeThe attribute to set
aValueThe value of the attribute
aErrorCodeThe error code to return when this attribute is requested via the GetValue() function
Return Value
Whether the new attribute value was set KErrNone if the value was set KErrNotFound if the attribute is not part of the set

operator[] ( TInt )

IMPORT_C TIntoperator[](TIntaIndex)const

Find the attribute stored at a particular index in the set

Parameters
aIndexThe index of the attribute
Return Value
The attribute, NOT the value of the attribute