Symbian^3 Product Developer Library >

CAlfPropertyOwner Class Reference

class CAlfPropertyOwner : public CBase

Value property object base class

Manages a list of properties. The current policy is that properties must always return a valid pointer, never NULL. Todomore

Inherits from

Public Member Functions
CAlfPropertyOwner()
~CAlfPropertyOwner()
IMPORT_C TIntCopyProperty(const CAlfPropertyOwner &, const TDesC8 &)
IMPORT_C voidPropertyClear()
IMPORT_C TBoolPropertyFindInteger(const TDesC8 &, TInt *)
IMPORT_C TBoolPropertyFindString(const TDesC8 &, TDesC **)
IMPORT_C TBoolPropertyRemove(const TDesC8 &)
IMPORT_C TBoolPropertySetIntegerL(const TDesC8 &, TInt, TInt, TInt)
IMPORT_C TBoolPropertySetStringL(const TDesC8 &, const TDesC &)
Protected Member Functions
IMPORT_C voidPropertyOwnerExtension(const TUid &, TAny **)
Private Member Functions
TBool Find(const TDesC8 &, TInt *, TAlfPropertyType *)
TBool FindOfType(const TDesC8 &, TInt *, TAlfPropertyType)
TBool PropertyFindInteger(const TDesC8 &, TRangedValue &)
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
RPointerArray< CAlfProperty >iProperties
TAny *iSpare

Constructor & Destructor Documentation

CAlfPropertyOwner()

IMPORT_CCAlfPropertyOwner()

~CAlfPropertyOwner()

IMPORT_C~CAlfPropertyOwner()

Member Functions Documentation

CopyProperty(const CAlfPropertyOwner &, const TDesC8 &)

IMPORT_C TIntCopyProperty(const CAlfPropertyOwner &aOwner,
const TDesC8 &aPropertyName
)

Copies named property from another object

Parameters

const CAlfPropertyOwner & aOwnerObject which has the property to be copied
const TDesC8 & aPropertyNameThe name of a property

Find(const TDesC8 &, TInt *, TAlfPropertyType *)

TBool Find(const TDesC8 &aName,
TInt *aIndex = NULL,
TAlfPropertyType *aType = NULL
)const [private]

Find a generic property object.

Parameters

const TDesC8 & aNamethe name of the property to find.
TInt * aIndex = NULLReturn parameter for index found.
TAlfPropertyType * aType = NULLReturn parameter for type found.

FindOfType(const TDesC8 &, TInt *, TAlfPropertyType)

TBool FindOfType(const TDesC8 &aName,
TInt *aIndex,
TAlfPropertyTypeaRequiredType
)const [private]

Find a property object of given type.

Does type checking to ensure that we got the expected property type.

Parameters

const TDesC8 & aNamethe name of the property to find.
TInt * aIndexReturn parameter for index found.
TAlfPropertyType aRequiredTypeType that is expected

PropertyClear()

IMPORT_C voidPropertyClear()

Remove all properties.

PropertyFindInteger(const TDesC8 &, TInt *)

IMPORT_C TBoolPropertyFindInteger(const TDesC8 &aName,
TInt *aRet = NULL
)const

Find the property by name. Can be overridden to provide custom handling of properties.

Parameters

const TDesC8 & aNamethe name of the property to find.
TInt * aRet = NULLReturn parameter for the found value, or NULL if no value required.

PropertyFindInteger(const TDesC8 &, TRangedValue &)

TBool PropertyFindInteger(const TDesC8 &aName,
TRangedValue &aValue
)const [private]

!Internal util: Find complete ranged value.

Parameters

const TDesC8 & aName
TRangedValue & aValue

PropertyFindString(const TDesC8 &, TDesC **)

IMPORT_C TBoolPropertyFindString(const TDesC8 &aName,
TDesC **aRet = NULL
)const

Find the property by name. Can be overridden to provide custom handling of properties.

Parameters

const TDesC8 & aNamethe name of the property to find.
TDesC ** aRet = NULLReturn parameter for the found value, or NULL if no value required.

PropertyOwnerExtension(const TUid &, TAny **)

IMPORT_C voidPropertyOwnerExtension(const TUid &aExtensionUid,
TAny **aExtensionParams
)[protected, virtual]

Parameters

const TUid & aExtensionUid
TAny ** aExtensionParams

PropertyRemove(const TDesC8 &)

IMPORT_C TBoolPropertyRemove(const TDesC8 &aName)

Remove the property by name, if it exists.

Parameters

const TDesC8 & aNamethe name of the property to remove.

PropertySetIntegerL(const TDesC8 &, TInt, TInt, TInt)

IMPORT_C TBoolPropertySetIntegerL(const TDesC8 &aName,
TIntaVal,
TIntaMin = INT_MIN,
TIntaMax = INT_MAX
)

Set a value property. This will set a property of type integer. If the property is already set, it will update the property's value. If not, it will create a new property. Can be overridden to provide custom handling of properties.

Parameters

const TDesC8 & aNamethe name of the property to set.
TInt aValThe value of the property.
TInt aMin = INT_MIN
TInt aMax = INT_MAX

PropertySetStringL(const TDesC8 &, const TDesC &)

IMPORT_C TBoolPropertySetStringL(const TDesC8 &aName,
const TDesC &aVal
)

Set a string property. This will set a property of type string. If the property is already set, it will update the property's value. If not, it will create a new property. Can be overridden to provide custom handling of properties.

Parameters

const TDesC8 & aNamethe name of the property to set.
const TDesC & aValThe value of the property.

Member Data Documentation

RPointerArray< CAlfProperty > iProperties

RPointerArray< CAlfProperty >iProperties[private]

TAny * iSpare

TAny *iSpare[private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.