S60 3rd Edition SDK for Symbian OS Example Applications Guide

CLandmarksModel Class Reference

#include <LandmarksModel.h>

List of all members.

Public Member Functions
	~CLandmarksModel ()
void	SetItemIds (RArray< TPosLmItemId > *aItemIds)
CDesCArraySeg *	ItemList ()
void	SetCurrentItem (TInt aIndex)
TPosLmItemId	CurrentItemId ()
CIconList *	CreateIconListL ()
void	RepopulateModelL (CArrayPtr< CPosLandmark > *aLandmarks)
Static Public Member Functions
static CLandmarksModel *	NewL ()
Private Member Functions
HBufC *	FormatListItemLC (CPosLandmark &aLandmark)
void	AppendIconL (const TDesC &aMbmFile, TInt aIconOffset, TInt aMaskOffset)
	CLandmarksModel ()
void	ConstructL ()
Private Attributes
TInt	iCurrentItem
	contains the current item in the model
CDesCArraySeg *	iListItems
	an array of formatted descriptors
RArray< TPosLmItemId > *	iItemIds
	an array of item ids matching the landmarks represented by iListItems
CIconList *	iIconList
	an array of landmark icons
TInt	iIndexToPopulate
	the next index to repopulate

---

Detailed Description

Contains the data model of the landmarks view.

Definition at line 34 of file LandmarksModel.h.

---

Constructor & Destructor Documentation

CLandmarksModel::~CLandmarksModel (   )

Destructor. Definition at line 69 of file LandmarksModel.cpp. References iListItems. { delete iListItems; }

CLandmarksModel::CLandmarksModel (   )  [private]

C++ constructor. Definition at line 39 of file LandmarksModel.cpp. { }

---

Member Function Documentation

CLandmarksModel * CLandmarksModel::NewL (   )  [static]

Two-phased constructor. Definition at line 59 of file LandmarksModel.cpp. References CLandmarksModel(). { CLandmarksModel* self = new (ELeave) CLandmarksModel(); CleanupStack::PushL(self); self->ConstructL(); CleanupStack::Pop(self); return self; }

void CLandmarksModel::SetItemIds (  RArray< TPosLmItemId > *  aItemIds  )

Sets the data member iItemIds Parameters: aItemIds  a pointer to an array of item ids Definition at line 80 of file LandmarksModel.cpp. References iItemIds, and iListItems. { iItemIds = aItemIds; // Empty descriptor model iListItems->Reset(); }

CDesCArraySeg * CLandmarksModel::ItemList (   )

Returns a pointer to an array to be used for a list box. Returns: an array of descriptors formatted to fit a CEikColumnListBox with one icon column to the left and one descriptor column to the right. Definition at line 94 of file LandmarksModel.cpp. References iListItems. { return iListItems; }

void CLandmarksModel::SetCurrentItem (  TInt  aIndex  )

Sets current item in the model. The current item should match the current selected one in the listbox displaying this model. Parameters: aIndex  the index of the current item in the list. Definition at line 105 of file LandmarksModel.cpp. References iCurrentItem. { iCurrentItem = aIndex; }

TPosLmItemId CLandmarksModel::CurrentItemId (   )

Returns the item id of the current item in the model. Returns: the item id of the current item in the model. KPosLmNullItemId if no item is set as current Definition at line 116 of file LandmarksModel.cpp. References iCurrentItem, and iItemIds. { if (!iItemIds || iCurrentItem < 0 || iCurrentItem > iItemIds->Count() - 1) { return KPosLmNullItemId; } return (*iItemIds)[iCurrentItem]; }

CIconList * CLandmarksModel::CreateIconListL (   )

Creates an array of icons that should be displayed be the listbox displaying the data of this model. Returns: an array of icons. Ownership of CIconList* is tranferred to caller Definition at line 133 of file LandmarksModel.cpp. References iIconList. { CIconList* iconList = (CIconList*) new (ELeave) CArrayPtrFlat<CGulIcon>(KGranularity); CleanupStack::PushL(iconList); // Create the default landmark icon consisting of its image and mask TAknsItemID aknsItemId = {0,0}; CGulIcon* icon = AknsUtils::CreateGulIconL(NULL, aknsItemId, KLandmarksMbmFileName, EMbmLmrefappDefault_lm, EMbmLmrefappDefault_lm_mask); CleanupStack::PushL(icon); icon->SetBitmapsOwnedExternally(EFalse); iconList->AppendL(icon); CleanupStack::Pop(2, iconList); // initialze iIconList. We don't need to delete any possible previous // iIconList since ownership is transferred to calling object. iIconList = iconList; return iIconList; }

void CLandmarksModel::RepopulateModelL (  CArrayPtr< CPosLandmark > *  aLandmarks  )

Repopulates a part of the model. Parameters: aLandmarks  the landmarks to insert to the model Definition at line 163 of file LandmarksModel.cpp. References FormatListItemLC(), and iListItems. { TInt nrOfReadItems = aLandmarks->Count(); // Format and insert the read landmarks for (TInt i = 0; i < nrOfReadItems; i++) { CPosLandmark* landmark = (*aLandmarks)[i]; HBufC* formattedListItem = FormatListItemLC(*landmark); iListItems->AppendL(*formattedListItem); CleanupStack::PopAndDestroy(formattedListItem); } }

HBufC * CLandmarksModel::FormatListItemLC (  CPosLandmark &  aLandmark  )  [private]

Formats a list item to fit a CEikColumnistBox with one graphic column and one descriptor column. Parameters: aLandmark  the landmarks this list item will represent Returns: a formatted descriptor buffer Definition at line 185 of file LandmarksModel.cpp. References AppendIconL(), and iIconList. { // Extract name TPtrC name; aLandmark.GetLandmarkName(name); // 10 extra chars for icon index and column separator const TInt KExtraChars = 10; HBufC* formattedNameBuf = HBufC::NewLC(name.Length() + KExtraChars); TPtr formattedNamePtr = formattedNameBuf->Des(); // Extract icon info TPtrC mbmIconFile; TInt iconIndex, maskIndex; TInt res = aLandmark.GetIcon(mbmIconFile, iconIndex, maskIndex); // Format list item if (res == KErrNone) { // Create icon and append it to icon array. TRAPD(err, AppendIconL(mbmIconFile, iconIndex, maskIndex)); if (err == KErrNone) { // Append the array index where the icon is appended formattedNamePtr.AppendNum(iIconList->Count() - 1); } else { formattedNamePtr.AppendNum(KDefaultIconIndex); } } else // res == KErrNotFound { formattedNamePtr.AppendNum(KDefaultIconIndex); } formattedNamePtr.Append(KTab); formattedNamePtr.Append(name); return formattedNameBuf; }

void CLandmarksModel::AppendIconL (  const TDesC &  aMbmFile, TInt  aIconOffset, TInt  aMaskOffset )  [private]

Appends an icen to the icon array. Parameters: aMbmFile  the multi bitmap file containing the icon to add aIconOffset  the offset in the mbm-file where the icon is located aMaskOffset  the offset in the mbm-file where the icon mask is located Definition at line 231 of file LandmarksModel.cpp. References iIconList. { TAknsItemID aknsItemId = {0,0}; CGulIcon* icon = AknsUtils::CreateGulIconL(NULL, aknsItemId, aMbmFile, aIconOffset, aMaskOffset); CleanupStack::PushL(icon); icon->SetBitmapsOwnedExternally(EFalse); iIconList->AppendL(icon); CleanupStack::Pop(icon); }

void CLandmarksModel::ConstructL (   )  [private]

By default Symbian 2nd phase constructor is private. Definition at line 48 of file LandmarksModel.cpp. References iListItems. { // The list box model uses MDesCArray interface class to take in text items. iListItems = new (ELeave) CDesCArraySeg(KGranularity); }

---

© Nokia 2006