Collapse all Symbian^3 Application Developer Library

CPosLmDisplayData Class Reference

class CPosLmDisplayData : public CBase

Displayable data collection.

A displayable data collection consists of displayable items ( CPosLmDisplayItem ). A displayable data collection either consists of landmark items (if a landmark search has been started) or category items (if a category search has been started). Items of different types cannot be mixed in the collection.

Displayable data is used in CPosLandmarkSearch and CPosLmMultiDbSearch to hold search results. The collection is populated with new results every time the next search step is executed. Displayable items contain full or partial (see CPosLandmarkDatabase::SetPartialReadParameters ) landmark data or full category data, and can be used to display search results already during the search and also after it has completed.

Note: The single class instance may only be used by one search instance at a time.

eposlmsearchlib.lib

Since: S60 3.0

Inherits from

CPosLmDisplayData
- CBase

Public Member Functions
	~CPosLmDisplayData ()
IMPORT_C TInt	Count ()
IMPORT_C CPosLmDisplayItem &	DisplayItem ( TInt )
RPointerArray < CPosLmDisplayItem > &	DisplayItems ()
RPointerArray < CPosLmDisplayItem > &	NewDisplayItems ()
IMPORT_C TInt	NewItemIndex ()
IMPORT_C CPosLmDisplayData *	NewL ()
CPosLmPartialReadParameters *	PartialReadParameters ()
IMPORT_C void	Reset ()
IMPORT_C void	SetPartialReadParametersL (const CPosLmPartialReadParameters &)
IMPORT_C void	UnsetPartialReadParameters ()

Private Member Functions
	CPosLmDisplayData ()

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 < CPosLmDisplayItem >	iDisplayItems
RPointerArray < CPosLmDisplayItem >	iNewDisplayItems
CPosLmPartialReadParameters *	iPartialParameters

Constructor & Destructor Documentation

CPosLmDisplayData()

CPosLmDisplayData

(

)

[private]

~CPosLmDisplayData()

~CPosLmDisplayData

(

)

[virtual]

Destructor.

Member Functions Documentation

Count()

IMPORT_C TInt

Count

(

)

const

Returns the number of items in the collection.

DisplayItem(TInt)

IMPORT_C CPosLmDisplayItem &

DisplayItem

(

TInt

aItemIndex

)

const

Returns the displayable item specified by index. The index must be strictly less than Count and not less than 0.

panic: "Landmarks Client"-EPosInvalidIndex Item index is beyond valid range.

Parameters

TInt aItemIndex

A displayable item index.

DisplayItems()

RPointerArray < CPosLmDisplayItem > &

DisplayItems

(

)

NewDisplayItems()

RPointerArray < CPosLmDisplayItem > &

NewDisplayItems

(

)

NewItemIndex()

IMPORT_C TInt

NewItemIndex

(

)

Returns the index of the next match found during current asynchronous search operation. If the search is executed synchronously, then all indexes of the matches found during the search are returned one by one.

After each search step, the new item indexes are returned in ascending order according to the specified sort preference in the search.

NewL()

IMPORT_C CPosLmDisplayData *

NewL

(

)

[static]

Two-phased constructor.

PartialReadParameters()

CPosLmPartialReadParameters *

PartialReadParameters

(

)

const

Reset()

IMPORT_C void

Reset

(

)

Resets the collection and deletes all contained items.

SetPartialReadParametersL(const CPosLmPartialReadParameters &)

IMPORT_C void

SetPartialReadParametersL

(

const CPosLmPartialReadParameters &

aPartialSettings

)

Sets the partial read parameters for this display data.

Partial read parameters are used to define which landmark data should be read during a landmark search. If no partial read parameters are set, the whole landmark will be read.

This function only affects the searches which are started after it is called. The current search is not affected.

If landmarks are sorted by name, the name will always be a part of the landmark in the display data, even if it is not requested.

Note: Partial read parameters are only used for landmark searches.

Parameters

const CPosLmPartialReadParameters & aPartialSettings

The partial read parameters.

UnsetPartialReadParameters()

IMPORT_C void

UnsetPartialReadParameters

(

)

Unsets the partial read parameters for this display data.

This means that from now on all landmarks added to this display data instance will contain all information.

To have any affect, this function must be called before a search is started. If it is called during a search, it will only affect the next search.

Note: Partial read parameters will only have effect on landmarks searches.

Member Data Documentation

RPointerArray< CPosLmDisplayItem > iDisplayItems

RPointerArray < CPosLmDisplayItem >

iDisplayItems

[private]

RPointerArray< CPosLmDisplayItem > iNewDisplayItems

RPointerArray < CPosLmDisplayItem >

iNewDisplayItems

[private]

CPosLmPartialReadParameters * iPartialParameters

CPosLmPartialReadParameters *

iPartialParameters

[private]