1.1 --- a/epoc32/include/mw/epos_cposlmidlistcriteria.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/mw/epos_cposlmidlistcriteria.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,105 @@
     1.4 -epos_cposlmidlistcriteria.h
     1.5 +/*
     1.6 +* Copyright (c) 2005-2006 Nokia Corporation and/or its subsidiary(-ies). 
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
    1.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description:  CPosLmIdListCriteria class
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +
    1.23 +#ifndef CPOSLMIDLISTCRITERIA_H
    1.24 +#define CPOSLMIDLISTCRITERIA_H
    1.25 +
    1.26 +#include <e32base.h>
    1.27 +#include <EPos_Landmarks.h>
    1.28 +#include "EPos_CPosLmSearchCriteria.h"
    1.29 +
    1.30 +/**
    1.31 +*  Landmark ID list search criterion.
    1.32 +*
    1.33 +*  This criterion is used if the client only wants to search a subset of the
    1.34 +*  landmarks in the database.
    1.35 +*
    1.36 +*  This criterion must be combined with other search criteria using a
    1.37 +*  @ref CPosLmCompositeCriteria. It is of no use on its own. If it is not
    1.38 +*  combined with another criterion,
    1.39 +*  @ref CPosLandmarkSearch::StartLandmarkSearchL will fail with error code
    1.40 +*  @p KErrArgument.
    1.41 +*
    1.42 +*  @p Example: If this criterion is combined with a @ref CPosLmTextCriteria,
    1.43 +*  the search operation searches the landmarks specified in the ID list
    1.44 +*  criterion and returns those which match the given text string.
    1.45 +*
    1.46 +*  Only one ID list criterion is allowed in each composite criterion, otherwise
    1.47 +*  @ref CPosLandmarkSearch::StartLandmarkSearchL will fail with error code
    1.48 +*  @p KErrArgument.
    1.49 +*
    1.50 +*  If the criterion does not contain any landmark IDs,
    1.51 +*  @ref CPosLandmarkSearch::StartLandmarkSearchL will fail with error code
    1.52 +*  @p KErrArgument.
    1.53 +*
    1.54 +*  @lib eposlmsearchlib.lib
    1.55 +*  @since S60 3.0
    1.56 +*/
    1.57 +class CPosLmIdListCriteria : public CPosLmSearchCriteria
    1.58 +    {
    1.59 +    public:
    1.60 +
    1.61 +        /**
    1.62 +        * Two-phased constructor.
    1.63 +        *
    1.64 +        * @returns A new instance of this class.
    1.65 +        */
    1.66 +        IMPORT_C static CPosLmIdListCriteria* NewLC();
    1.67 +
    1.68 +        /**
    1.69 +        * Destructor
    1.70 +        */
    1.71 +        IMPORT_C virtual ~CPosLmIdListCriteria();
    1.72 +
    1.73 +    public:
    1.74 +
    1.75 +        /**
    1.76 +        * Sets the IDs of the landmarks which should be included in the search.
    1.77 +        *
    1.78 +        * @param[in] aIdArray The IDs of the landmarks which should be included
    1.79 +        *   in the search.
    1.80 +        */
    1.81 +        IMPORT_C void SetLandmarkIdsL( const RArray<TPosLmItemId>&  aIdArray );
    1.82 +
    1.83 +        /**
    1.84 +        * Retrieves the list of IDs of the landmarks which should be included
    1.85 +        * in the search.
    1.86 +        *
    1.87 +        * @param[out] aIdArray On return, contains the IDs of the landmarks which
    1.88 +        *   should be included in the search.
    1.89 +        */
    1.90 +        IMPORT_C void GetLandmarkIdsL( RArray<TPosLmItemId>&  aIdArray ) const;
    1.91 +
    1.92 +    private:
    1.93 +
    1.94 +        // C++ constructor
    1.95 +        CPosLmIdListCriteria();
    1.96 +
    1.97 +        // Prohibit copy constructor
    1.98 +        CPosLmIdListCriteria( const CPosLmIdListCriteria& );
    1.99 +        // Prohibit assigment operator
   1.100 +        CPosLmIdListCriteria& operator= ( const CPosLmIdListCriteria& );
   1.101 +
   1.102 +    private:
   1.103 +
   1.104 +        RArray<TPosLmItemId> iIdArray;
   1.105 +    };
   1.106 +
   1.107 +#endif      // CPOSLMIDLISTCRITERIA_H
   1.108 +
   1.109 +