Symbian^3 Product Developer Library >

Alf::MulVisualItem Class Reference

class Alf::MulVisualItem

/*! Visual item is set of attributes corresponding to an item in the widget. The attributes added to visual item get visualized on the widget

Nested Classes and Structures

Public Member Functions
MulVisualItem()
MulVisualItem(const MulVisualItem &)
~MulVisualItem()
OSN_IMPORT IMulVariantType *Attribute(mulvisualitem::TVisualAttribute)
OSN_IMPORT intAttributeAsInt(mulvisualitem::TVisualAttribute)
OSN_IMPORT const TDesC &AttributeAsString(mulvisualitem::TVisualAttribute)
OSN_IMPORT const std::vector< mulvisualitem::TVisualAttribute >Attributes()
intFlag(mulvisualitem::TVisualAttribute)
OSN_IMPORT boolIsDirty(mulvisualitem::TVisualAttribute)
voidRemoveAttribute(mulvisualitem::TVisualAttribute)
voidResetDirtyAttribute(const MulVisualItem &)
OSN_IMPORT voidSetAttribute(mulvisualitem::TVisualAttribute, int, int)
OSN_IMPORT voidSetAttribute(mulvisualitem::TVisualAttribute, const TDesC &, int)
OSN_IMPORT voidSetAttribute(mulvisualitem::TVisualAttribute, IMulVariantType *, int, TAttributeOwnership)
voidSetDirty(mulvisualitem::TVisualAttribute, bool)
Public Member Enumerations
enumTAttributeFlags { EDisposable = 0x01 }
enumTAttributeOwnership { EDoesOwn = 0, EDoesNotOwn }
Private Attributes
unsigned intmBitAttrFlag1
unsigned intmBitAttrFlag2
std::map< mulvisualitem::TVisualAttribute, MulAttribute * >mVisualItem

Constructor & Destructor Documentation

MulVisualItem()

OSN_IMPORTMulVisualItem()

C++ constructor.

MulVisualItem(const MulVisualItem &)

OSN_IMPORTMulVisualItem(const MulVisualItem &aVisualData)

C++ constructor.

Parameters

const MulVisualItem & aVisualData

~MulVisualItem()

OSN_IMPORT~MulVisualItem()

Destructor.

Member Functions Documentation

Attribute(mulvisualitem::TVisualAttribute)

OSN_IMPORT IMulVariantType *Attribute(mulvisualitem::TVisualAttributeaName)const

Return Value of specified attribute

Parameters

mulvisualitem::TVisualAttribute aNamename of attribute need to retrived

AttributeAsInt(mulvisualitem::TVisualAttribute)

OSN_IMPORT intAttributeAsInt(mulvisualitem::TVisualAttributeaName)const

Return Value of specified attribute as integer

Parameters

mulvisualitem::TVisualAttribute aNamename of attribute need to retrived

AttributeAsString(mulvisualitem::TVisualAttribute)

OSN_IMPORT const TDesC &AttributeAsString(mulvisualitem::TVisualAttributeaName)const

Return Value of specified attribute as String

Parameters

mulvisualitem::TVisualAttribute aNamename of attribute need to retrived

Attributes()

OSN_IMPORT const std::vector< mulvisualitem::TVisualAttribute >Attributes()const

Return the existing attributes of the visual item

Flag(mulvisualitem::TVisualAttribute)

intFlag(mulvisualitem::TVisualAttributeaName)

Return the flag of the attributes

Parameters

mulvisualitem::TVisualAttribute aNamename of attribute need to retrived

IsDirty(mulvisualitem::TVisualAttribute)

OSN_IMPORT boolIsDirty(mulvisualitem::TVisualAttributeaAttr)const

Return the bool value if attribute is dirty(updated and not redrawn)

Parameters

mulvisualitem::TVisualAttribute aAttr

RemoveAttribute(mulvisualitem::TVisualAttribute)

voidRemoveAttribute(mulvisualitem::TVisualAttributeaName)

Remove attribute from visual item - required by garbage collector

Parameters

mulvisualitem::TVisualAttribute aNameAttribute name to be removed

ResetDirtyAttribute(const MulVisualItem &)

voidResetDirtyAttribute(const MulVisualItem &aVisualItem)

Resets the dirty flag for a Visual attribute from input Visual item

Parameters

const MulVisualItem & aVisualItem

SetAttribute(mulvisualitem::TVisualAttribute, int, int)

OSN_IMPORT voidSetAttribute(mulvisualitem::TVisualAttributeaName,
intaValue,
intaAttributeFlags = 0
)

Add new attribute to visual item

Parameters

mulvisualitem::TVisualAttribute aNamename of attribute
int aValuevalue of attribute
int aAttributeFlags = 0property of this attribute

SetAttribute(mulvisualitem::TVisualAttribute, const TDesC &, int)

OSN_IMPORT voidSetAttribute(mulvisualitem::TVisualAttributeaName,
const TDesC &aValue,
intaAttributeFlags = 0
)

Add new attribute to visual item

Parameters

mulvisualitem::TVisualAttribute aNamename of attribute
const TDesC & aValuevalue of attribute
int aAttributeFlags = 0property of this attribute

SetAttribute(mulvisualitem::TVisualAttribute, IMulVariantType *, int, TAttributeOwnership)

OSN_IMPORT voidSetAttribute(mulvisualitem::TVisualAttributeaName,
IMulVariantType *aValue,
intaAttributeFlags = 0,
TAttributeOwnershipaAttributeOwership = EDoesOwn
)

Add new attribute to visual item

Parameters

mulvisualitem::TVisualAttribute aNamename of attribute
IMulVariantType * aValuevalue of attribute
int aAttributeFlags = 0property of this attribute
TAttributeOwnership aAttributeOwership = EDoesOwnIf the value is EDoesOwn then the ownership of the attribute transfered to the visual item else not.

SetDirty(mulvisualitem::TVisualAttribute, bool)

voidSetDirty(mulvisualitem::TVisualAttributeaAttr,
boolaDirty
)

Sets the dirty flag for a Visual attribute

Parameters

mulvisualitem::TVisualAttribute aAttr
bool aDirtysets dirty flag to true/false

Member Enumerations Documentation

Enum TAttributeFlags

Flags for attribute

Enumerators

EDisposable = 0x01

Enum TAttributeOwnership

Enumerators

EDoesOwn = 0
EDoesNotOwn

Member Data Documentation

unsigned int mBitAttrFlag1

unsigned intmBitAttrFlag1[private]

unsigned int mBitAttrFlag2

unsigned intmBitAttrFlag2[private]

std::map< mulvisualitem::TVisualAttribute, MulAttribute * > mVisualItem

std::map< mulvisualitem::TVisualAttribute, MulAttribute * >mVisualItem[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.