S60 3rd Edition SDK for Symbian OS Example Applications Guide

LandmarksListBoxModel.h

/*
* ==============================================================================
*  Name        : LandmarksListBoxModel.h
*  Part of     : Landmark Reference Application
*  Interface   : Application Engine API
*  Description : See class description below
*  Version     : 1.0
*
*  Copyright (c) 2004-2006 Nokia Corporation.
*  This material, including documentation and any related 
*  computer programs, is protected by copyright controlled by 
*  Nokia Corporation.
* ==============================================================================
*/

#ifndef __LANDMARKS_LIST_BOX_MODEL_H__
#define __LANDMARKS_LIST_BOX_MODEL_H__

// INCLUDES
#include <aknutils.h>

// CLASS DECLARATION

/**
*  CLandmarksListBoxModel bypasses the default filtering algorithm provided by 
*  CAknFilteredTextListBoxModel. The filtering responsibility is forwarded to 
*  the CCoeControl instance owning the list box. That instance must update the
*  model when the filter has been modified.
*/
class CLandmarksListBoxModel : public CAknFilteredTextListBoxModel
    {
    public: // from CAknFilteredTextListBoxModel

        /**
        * Gets an array of strings to be displayed in the listbox for 
        * incremental matching of typed characters. This array always contains 
        * the total number of items rather than a subset filtered out from the 
        * model.
        *
        * @return A text array for matching.
        */
        const MDesCArray* MatchableTextArray() const;

        /**
        * Gets the number of text items in this list box model. This number is 
        * always the total number of items in the model rather than a subset 
        * filtered out from the model
        *
        * @return The number of text items in this list box model
        */
        TInt NumberOfItems() const;

        /**
        * Gets the text to be displayed in the list box control for a specific 
        * item.
        *
        * @param aItemIndex Index of an item
        * @return Text string to be displayed
        */
        TPtrC ItemText(TInt aItemIndex) const;

    };

#endif // __LANDMARKS_LIST_BOX_MODEL_H__

// End of File

---

© Nokia 2006