Collapse all Symbian^3 Product Developer Library

CPbk2IconArray Class Reference

class CPbk2IconArray : public CArrayPtrFlat< CGulIcon >

An icon array for Phonebook 2 icons. Responsible for:

specializing icon array for Phonebook

Inherits from

CPbk2IconArray
- CArrayPtrFlat< CGulIcon >
  - CArrayPtr
    - CArrayFix< T * >
      - CArrayFixBase
        CBase

Nested Classes and Structures

CPbk2IconArray::CIdArray

Public Member Functions
	~CPbk2IconArray()
IMPORT_C void	AppendIconL(CGulIcon *, const TPbk2IconId &)
IMPORT_C void	AppendIconL(CPbk2IconInfo *)
IMPORT_C void	AppendIconsFromResourceL(TResourceReader &, const CPbk2IconInfoContainer &)
IMPORT_C TInt	FindAndCreateIconL(const TPbk2IconId &)
IMPORT_C TInt	FindIcon(const TPbk2IconId &)
IMPORT_C TPbk2IconArrayId	Id()
IMPORT_C CPbk2IconArray *	NewL(TResourceReader &)
IMPORT_C CPbk2IconArray *	NewL(const MPbk2FieldPropertyArray &)
IMPORT_C CPbk2IconArray *	NewL(TResourceReader &, const CPbk2IconInfoContainer &)
IMPORT_C void	RefreshL()
IMPORT_C void	RefreshL(const CPbk2IconInfoContainer &)
IMPORT_C TInt	RemoveIcon(const TPbk2IconId &)

Private Member Functions
	CPbk2IconArray()
void	AppendDefaultIconsL(const CPbk2IconFactory &)
void	AppendIconWithMappingL(const CPbk2IconFactory &, const TPbk2IconId &)
void	BaseConstructL()
void	ConstructL()
void	ConstructL(TResourceReader &)
void	ConstructL(const MPbk2FieldPropertyArray &)
void	ConstructL(TResourceReader &, const CPbk2IconInfoContainer &)
void	DoAppendIconsFromResourceL(TResourceReader &, const CPbk2IconFactory &, TBool)
void	DoRefreshL(const CPbk2IconFactory &)
void	ReserveMemoryL(TInt)

Inherited Functions
	CArrayFix< CGulIcon * >::AppendL(const CGulIcon *&)
	CArrayFix< CGulIcon * >::AppendL(const CGulIcon *&,TInt)
	CArrayFix< CGulIcon * >::AppendL(const CGulIcon **,TInt)
	CArrayFix< CGulIcon * >::Array()const
	CArrayFix< CGulIcon * >::At(TInt)
	CArrayFix< CGulIcon * >::At(TInt)const
	CArrayFix< CGulIcon * >::Back(TInt)
	CArrayFix< CGulIcon * >::Back(TInt)const
	CArrayFix< CGulIcon * >::CArrayFix(TBufRep,TInt)
	CArrayFix< CGulIcon * >::End(TInt)
	CArrayFix< CGulIcon * >::End(TInt)const
	CArrayFix< CGulIcon * >::ExpandL(TInt)
	CArrayFix< CGulIcon * >::ExtendL()
	CArrayFix< CGulIcon * >::Find(const CGulIcon *&,TKeyArrayFix &,TInt &)const
	CArrayFix< CGulIcon * >::FindIsq(const CGulIcon *&,TKeyArrayFix &,TInt &)const
	CArrayFix< CGulIcon * >::InsertIsqAllowDuplicatesL(const CGulIcon *&,TKeyArrayFix &)
	CArrayFix< CGulIcon * >::InsertIsqL(const CGulIcon *&,TKeyArrayFix &)
	CArrayFix< CGulIcon * >::InsertL(TInt,const CGulIcon *&)
	CArrayFix< CGulIcon * >::InsertL(TInt,const CGulIcon *&,TInt)
	CArrayFix< CGulIcon * >::InsertL(TInt,const CGulIcon **,TInt)
	CArrayFix< CGulIcon * >::ResizeL(TInt)
	CArrayFix< CGulIcon * >::ResizeL(TInt,const CGulIcon *&)
	CArrayFix< CGulIcon * >::operator[](TInt)
	CArrayFix< CGulIcon * >::operator[](TInt)const
	CArrayFixBase::AtR(const CBase *,TInt)
	CArrayFixBase::CArrayFixBase(TBufRep,TInt,TInt)
	CArrayFixBase::Compress()
	CArrayFixBase::Count()const
	CArrayFixBase::CountR(const CBase *)
	CArrayFixBase::Delete(TInt)
	CArrayFixBase::Delete(TInt,TInt)
	CArrayFixBase::Find(const TAny *,TKeyArrayFix &,TInt &)const
	CArrayFixBase::FindIsq(const TAny *,TKeyArrayFix &,TInt &)const
	CArrayFixBase::InsertIsqAllowDuplicatesL(const TAny *,TKeyArrayFix &)
	CArrayFixBase::InsertIsqL(const TAny *,TKeyArrayFix &)
	CArrayFixBase::InsertL(TInt,const TAny *)
	CArrayFixBase::InsertL(TInt,const TAny *,TInt)
	CArrayFixBase::InsertRepL(TInt,const TAny *,TInt)
	CArrayFixBase::Length()const
	CArrayFixBase::Reset()
	CArrayFixBase::ResizeL(TInt,const TAny *)
	CArrayFixBase::SetKey(TKeyArrayFix &)const
	CArrayFixBase::SetReserveFlatL(TInt)
	CArrayFixBase::Sort(TKeyArrayFix &)
	CArrayFixBase::~CArrayFixBase()
	CArrayPtr< CGulIcon >::CArrayPtr(TBufRep,TInt)
	CArrayPtr< CGulIcon >::ResetAndDestroy()
	CArrayPtrFlat< CGulIcon >::CArrayPtrFlat(TInt)
	CArrayPtrFlat< CGulIcon >::SetReserveL(TInt)
	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
TPbk2IconArrayId	iArrayId
CPbk2IconFactory *	iIconFactory
CIdArray *	iIdMap

Constructor & Destructor Documentation

CPbk2IconArray()

CPbk2IconArray

(

)

[private]

~CPbk2IconArray()

~CPbk2IconArray

(

)

Destructor. Calls ResetAndDestroy.

Member Functions Documentation

AppendDefaultIconsL(const CPbk2IconFactory &)

void

AppendDefaultIconsL

(

const CPbk2IconFactory &

aIconFactory

)

[private]

Parameters

const CPbk2IconFactory & aIconFactory

AppendIconL(CGulIcon *, const TPbk2IconId &)

IMPORT_C void	AppendIconL	(	CGulIcon *	aIcon,
			const TPbk2IconId &	aIconId
		)

Appends a new icon to this array. Takes ownership of the icon. Doesn't change the if of this array.

Parameters

CGulIcon * aIcon	Icon to appended. Ownership of the icon is taken.
const TPbk2IconId & aIconId

AppendIconL(CPbk2IconInfo *)

IMPORT_C void

AppendIconL

(

CPbk2IconInfo *

aIconInfo

)

Appends a new icon to this array.

Parameters

CPbk2IconInfo * aIconInfo

Icon to be appended. Ownership of the iconInfo is taken.

AppendIconWithMappingL(const CPbk2IconFactory &, const TPbk2IconId &)

void	AppendIconWithMappingL	(	const CPbk2IconFactory &	aIconFactory,
			const TPbk2IconId &	aIconId
		)	[private]

Parameters

const CPbk2IconFactory & aIconFactory
const TPbk2IconId & aIconId

AppendIconsFromResourceL(TResourceReader &, const CPbk2IconInfoContainer &)

IMPORT_C void	AppendIconsFromResourceL	(	TResourceReader &	aReader,
			const CPbk2IconInfoContainer &	aIconInfoContainer
		)

Appends new icons from given resource to this array. Doesn't change the if of this array.

Parameters

TResourceReader & aReader	Resource reader pointed to PBK2_ICON_ARRAY resource.
const CPbk2IconInfoContainer & aIconInfoContainer	Icon infos that are needed in icon creation.

BaseConstructL()

void

BaseConstructL

(

)

[private]

ConstructL()

void

ConstructL

(

)

[private]

ConstructL(TResourceReader &)

void

ConstructL

(

TResourceReader &

aReader

)

[private]

Parameters

TResourceReader & aReader

ConstructL(const MPbk2FieldPropertyArray &)

void

ConstructL

(

const MPbk2FieldPropertyArray &

aFieldProperties

)

[private]

Parameters

const MPbk2FieldPropertyArray & aFieldProperties

ConstructL(TResourceReader &, const CPbk2IconInfoContainer &)

void	ConstructL	(	TResourceReader &	aReader,
			const CPbk2IconInfoContainer &	aIconInfoContainer
		)	[private]

Parameters

TResourceReader & aReader
const CPbk2IconInfoContainer & aIconInfoContainer

DoAppendIconsFromResourceL(TResourceReader &, const CPbk2IconFactory &, TBool)

void	DoAppendIconsFromResourceL	(	TResourceReader &	aReader,
			const CPbk2IconFactory &	aIconFactory,
			TBool	aUpdateId
		)	[private]

Parameters

TResourceReader & aReader
const CPbk2IconFactory & aIconFactory
TBool aUpdateId

DoRefreshL(const CPbk2IconFactory &)

void

DoRefreshL

(

const CPbk2IconFactory &

aFactory

)

[private]

Parameters

const CPbk2IconFactory & aFactory

FindAndCreateIconL(const TPbk2IconId &)

IMPORT_C TInt

FindAndCreateIconL

(

const TPbk2IconId &

aIconId

)

This function first calls FindIcon, and if it doesn't find the icon it creates it by using core Phonebook 2 icons. The created icon is then appended to this array. If the icon id is defined in Phonebook UI extension then it is not possible to create it by using this function.

Parameters

const TPbk2IconId & aIconId

Icon id to search for.

FindIcon(const TPbk2IconId &)

IMPORT_C TInt

FindIcon

(

const TPbk2IconId &

aIconId

)

const

Returns the index of the icon with aIconId in this array.

Parameters

const TPbk2IconId & aIconId

Icon id to search for.

Id()

IMPORT_C TPbk2IconArrayId

(

)

const

Returns the Phonebook 2 icon array id.

NewL(TResourceReader &)

IMPORT_C CPbk2IconArray *

NewL

(

TResourceReader &

aReader

)

[static]

Constructs an array of core Phonebook 2 icons specified in the resource.

Parameters

TResourceReader & aReader

A resource reader pointed to PBK2_ICON_ARRAY resource.

NewL(const MPbk2FieldPropertyArray &)

IMPORT_C CPbk2IconArray *

NewL

(

const MPbk2FieldPropertyArray &

aFieldProperties

)

[static]

Constructs a core Phonebook 2 field type icon array. Adds qgn_indi_marked_add into first position as the Avkon needs that. Adds also en empty icon qgn_prop_nrtyp_empty to make it always available. The id of this array is EPbk2FieldTypeIconArrayId after the construction.

Parameters

const MPbk2FieldPropertyArray & aFieldProperties

Phonebook 2 field properties. Reference is not saved but used in construction only.

NewL(TResourceReader &, const CPbk2IconInfoContainer &)

IMPORT_C CPbk2IconArray *	NewL	(	TResourceReader &	aReader,
			const CPbk2IconInfoContainer &	aIconInfoContainer
		)	[static]

Constructs an icon array using a given icon info container.

Parameters

TResourceReader & aReader	A resource reader pointed to PBK2_ICON_ARRAY resource.
const CPbk2IconInfoContainer & aIconInfoContainer	Icon infos that are needed in icon creation.

RefreshL()

IMPORT_C void

RefreshL

(

)

Refreshes core Phonebook 2 icons.

RefreshL(const CPbk2IconInfoContainer &)

IMPORT_C void

RefreshL

(

const CPbk2IconInfoContainer &

aIconInfoContainer

)

Refreshes the icons from the given container.

Parameters

const CPbk2IconInfoContainer & aIconInfoContainer

The container of icons to refresh.

RemoveIcon(const TPbk2IconId &)

IMPORT_C TInt

RemoveIcon

(

const TPbk2IconId &

aIconId

)

Removes icon from the CArrayPtrFlat - array and the TPbk2IconId from the iIdMap - array

Parameters

const TPbk2IconId & aIconId

Icon id to be removed

ReserveMemoryL(TInt)

void

ReserveMemoryL

(

TInt

aAmount

)

[private]

Parameters

TInt aAmount

Member Data Documentation

TPbk2IconArrayId iArrayId

TPbk2IconArrayId

iArrayId

[private]

CPbk2IconFactory * iIconFactory

CPbk2IconFactory *

iIconFactory

[private]

CIdArray * iIdMap

CIdArray *

iIdMap

[private]