Symbian^3 Application 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 int AttributeAsInt ( mulvisualitem::TVisualAttribute )
OSN_IMPORT const TDesC & AttributeAsString ( mulvisualitem::TVisualAttribute )
OSN_IMPORT const std::vector< mulvisualitem::TVisualAttribute > Attributes ()
int Flag ( mulvisualitem::TVisualAttribute )
OSN_IMPORT bool IsDirty ( mulvisualitem::TVisualAttribute )
void RemoveAttribute ( mulvisualitem::TVisualAttribute )
void ResetDirtyAttribute (const MulVisualItem &)
OSN_IMPORT void SetAttribute ( mulvisualitem::TVisualAttribute , int, int)
OSN_IMPORT void SetAttribute ( mulvisualitem::TVisualAttribute , const TDesC &, int)
OSN_IMPORT void SetAttribute ( mulvisualitem::TVisualAttribute , IMulVariantType *, int, TAttributeOwnership )
void SetDirty ( mulvisualitem::TVisualAttribute , bool)
Public Member Enumerations
enum TAttributeFlags { EDisposable  = 0x01 }
enum TAttributeOwnership { EDoesOwn  = 0, EDoesNotOwn }
Private Attributes
unsigned int mBitAttrFlag1
unsigned int mBitAttrFlag2
std::map< mulvisualitem::TVisualAttribute , MulAttribute * > mVisualItem

Constructor & Destructor Documentation

MulVisualItem()

OSN_IMPORT MulVisualItem ( )

C++ constructor.

MulVisualItem(const MulVisualItem &)

OSN_IMPORT MulVisualItem ( 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::TVisualAttribute aName ) const

Return Value of specified attribute

Parameters

mulvisualitem::TVisualAttribute aName name of attribute need to retrived

AttributeAsInt(mulvisualitem::TVisualAttribute)

OSN_IMPORT int AttributeAsInt ( mulvisualitem::TVisualAttribute aName ) const

Return Value of specified attribute as integer

Parameters

mulvisualitem::TVisualAttribute aName name of attribute need to retrived

AttributeAsString(mulvisualitem::TVisualAttribute)

OSN_IMPORT const TDesC & AttributeAsString ( mulvisualitem::TVisualAttribute aName ) const

Return Value of specified attribute as String

Parameters

mulvisualitem::TVisualAttribute aName name 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)

int Flag ( mulvisualitem::TVisualAttribute aName )

Return the flag of the attributes

Parameters

mulvisualitem::TVisualAttribute aName name of attribute need to retrived

IsDirty(mulvisualitem::TVisualAttribute)

OSN_IMPORT bool IsDirty ( mulvisualitem::TVisualAttribute aAttr ) const

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

Parameters

mulvisualitem::TVisualAttribute aAttr

RemoveAttribute(mulvisualitem::TVisualAttribute)

void RemoveAttribute ( mulvisualitem::TVisualAttribute aName )

Remove attribute from visual item - required by garbage collector

Parameters

mulvisualitem::TVisualAttribute aName Attribute name to be removed

ResetDirtyAttribute(const MulVisualItem &)

void ResetDirtyAttribute ( 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 void SetAttribute ( mulvisualitem::TVisualAttribute aName,
int aValue,
int aAttributeFlags = 0
)

Add new attribute to visual item

Parameters

mulvisualitem::TVisualAttribute aName name of attribute
int aValue value of attribute
int aAttributeFlags = 0 property of this attribute

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

OSN_IMPORT void SetAttribute ( mulvisualitem::TVisualAttribute aName,
const TDesC & aValue,
int aAttributeFlags = 0
)

Add new attribute to visual item

Parameters

mulvisualitem::TVisualAttribute aName name of attribute
const TDesC & aValue value of attribute
int aAttributeFlags = 0 property of this attribute

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

OSN_IMPORT void SetAttribute ( mulvisualitem::TVisualAttribute aName,
IMulVariantType * aValue,
int aAttributeFlags = 0,
TAttributeOwnership aAttributeOwership = EDoesOwn
)

Add new attribute to visual item

Parameters

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

SetDirty(mulvisualitem::TVisualAttribute, bool)

void SetDirty ( mulvisualitem::TVisualAttribute aAttr,
bool aDirty
)

Sets the dirty flag for a Visual attribute

Parameters

mulvisualitem::TVisualAttribute aAttr
bool aDirty sets 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 int mBitAttrFlag1 [private]

unsigned int mBitAttrFlag2

unsigned int mBitAttrFlag2 [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.