CPosLmDisplayData Class Reference

API published in: S60 3rd Ed

Link against: eposlmsearchlib.lib eposlmmultidbsearch.lib

Capability Information

Required Capabilities

None

Exceptions

The capability ReadUserData is required in:

CPosLandmarkSearch::StartLandmarkSearchL( const CPosLmSearchCriteria & aCriteria, TBool aSearchOnlyPreviousMatches = EFalse );

CPosLandmarkSearch::StartLandmarkSearchL( const CPosLmSearchCriteria & aCriteria, const TPosLmSortPref & aSortPref, TBool aSearchOnlyPreviousMatches = EFalse );

CPosLandmarkSearch::StartCategorySearchL( const CPosLmSearchCriteria & aCriteria, CPosLmCategoryManager::TCategorySortPref aSortPref, TBool aSearchOnlyPreviousMatches = EFalse );

CPosLmMultiDbSearch::StartLandmarkSearchL( const CPosLmSearchCriteria & aCriteria, TBool aSearchOnlyPreviousMatches = EFalse );

CPosLmMultiDbSearch::StartLandmarkSearchL( const CPosLmSearchCriteria & aCriteria, const TPosLmSortPref & aSortPref, TBool aSearchOnlyPreviousMatches = EFalse );

CPosLmMultiDbSearch::StartCategorySearchL( const CPosLmSearchCriteria & aCriteria, CPosLmCategoryManager::TCategorySortPref aSortPref, TBool aSearchOnlyPreviousMatches = EFalse );

Other Information

The capability NetworkServices is required to work with remote databases.

#include <epos_cposlmdisplaydata.h>

Detailed Description

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.


Public Member Functions
virtual  ~CPosLmDisplayData ()
  Destructor.
IMPORT_C TInt  NewItemIndex ()
  Returns the index of the next match found during current asynchronous search operation.
IMPORT_C TInt  Count () const
  Returns the number of items in the collection.
IMPORT_C void  Reset ()
  Resets the collection and deletes all contained items.
IMPORT_C CPosLmDisplayItem &  DisplayItem (TInt aItemIndex) const
  Returns the displayable item specified by index.
IMPORT_C void  SetPartialReadParametersL (const CPosLmPartialReadParameters &aPartialSettings)
  Sets the partial read parameters for this display data.
IMPORT_C void  UnsetPartialReadParameters ()
  Unsets the partial read parameters for this display data.
CPosLmPartialReadParameters *  PartialReadParameters () const
RPointerArray< CPosLmDisplayItem > &  DisplayItems ()
RPointerArray< CPosLmDisplayItem > &  NewDisplayItems ()

Static Public Member Functions
static IMPORT_C CPosLmDisplayData *  NewL ()
  Two-phased constructor.

Constructor & Destructor Documentation

virtual CPosLmDisplayData::~CPosLmDisplayData (   )  [virtual]
 

Destructor.

Member Function Documentation

IMPORT_C TInt CPosLmDisplayData::Count (   )  const
 

Returns the number of items in the collection.

Returns:
The number of items.
IMPORT_C CPosLmDisplayItem& CPosLmDisplayData::DisplayItem (  TInt  aItemIndex  )  const
 

Returns the displayable item specified by index.

The index must be strictly less than Count and not less than 0.

Parameters:
[in]  aItemIndex  A displayable item index.
Returns:
A displayable item.
Panic:
"Landmarks Client"-EPosInvalidIndex Item index is beyond valid range.
RPointerArray<CPosLmDisplayItem>& CPosLmDisplayData::DisplayItems (   ) 
 
RPointerArray<CPosLmDisplayItem>& CPosLmDisplayData::NewDisplayItems (   ) 
 
IMPORT_C TInt CPosLmDisplayData::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.

Returns:
The item index or KPosLmNoNewItems when no new items are available.
static IMPORT_C CPosLmDisplayData* CPosLmDisplayData::NewL (   )  [static]
 

Two-phased constructor.

Returns:
A new instance of this class.
CPosLmPartialReadParameters* CPosLmDisplayData::PartialReadParameters (   )  const
 
IMPORT_C void CPosLmDisplayData::Reset (   ) 
 

Resets the collection and deletes all contained items.

IMPORT_C void CPosLmDisplayData::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:
[in]  aPartialSettings  The partial read parameters.
IMPORT_C void CPosLmDisplayData::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.

The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top