1.1 --- a/epoc32/include/mw/epos_cposlmcatnamecriteria.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/mw/epos_cposlmcatnamecriteria.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,104 @@
     1.4 -epos_cposlmcatnamecriteria.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:  CPosLmCatNameCriteria class
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +
    1.23 +#ifndef CPOSLMCATNAMECRITERIA_H
    1.24 +#define CPOSLMCATNAMECRITERIA_H
    1.25 +
    1.26 +#include <e32base.h>
    1.27 +#include "EPos_CPosLmSearchCriteria.h"
    1.28 +
    1.29 +/**
    1.30 +*  Criterion for searching landmark categories with a certain name.
    1.31 +*
    1.32 +*  Wild-card characters are supported.
    1.33 +*
    1.34 +*  The client specifies the search pattern and starts the search using
    1.35 +*  @ref CPosLandmarkSearch. The search returns all categories which
    1.36 +*  match the search pattern.
    1.37 +*
    1.38 +*  This criterion is only valid when searching for landmark categories, i.e. if
    1.39 +*  it is passed to @p CPosLandmarkSearch::StartLandmarkSearchL, the function
    1.40 +*  will fail with error code @p KErrArgument.
    1.41 +*
    1.42 +*  @lib eposlmsearchlib.lib
    1.43 +*  @since S60 3.0
    1.44 +*/
    1.45 +class CPosLmCatNameCriteria : public CPosLmSearchCriteria
    1.46 +    {
    1.47 +    public:
    1.48 +
    1.49 +        /**
    1.50 +        * Two-phased constructor.
    1.51 +        * @returns A new instance of this class.
    1.52 +        */
    1.53 +        IMPORT_C static CPosLmCatNameCriteria* NewLC();
    1.54 +
    1.55 +        /**
    1.56 +        * Destructor.
    1.57 +        */
    1.58 +        virtual ~CPosLmCatNameCriteria();
    1.59 +
    1.60 +    public:
    1.61 +
    1.62 +        /**
    1.63 +        * Retrieves the search pattern.
    1.64 +        *
    1.65 +        * @return The category name search pattern.
    1.66 +        */
    1.67 +        IMPORT_C TPtrC SearchPattern() const;
    1.68 +
    1.69 +        /**
    1.70 +        * Sets the search pattern.
    1.71 +        *
    1.72 +        * A non-empty search pattern must be set, otherwise
    1.73 +        * @ref CPosLandmarkSearch::StartCategorySearchL will leave with error
    1.74 +        * code @p KErrArgument.
    1.75 +        *
    1.76 +        * The search is case insensitive.
    1.77 +        *
    1.78 +        * Wild-card characters "?" and "*" are supported in the search string.
    1.79 +        * "?" matches a single occurrence of any character and "*" matches
    1.80 +        * zero or more consecutive occurrences of any characters.
    1.81 +        *
    1.82 +        * @param[in] aSearchPattern The pattern used to find categories.
    1.83 +        *
    1.84 +        * @leave KErrArgument The search pattern is longer than 
    1.85 +        *   @p KPosLmMaxCategoryNameLength.
    1.86 +        */
    1.87 +        IMPORT_C void SetSearchPatternL( const TDesC& aSearchPattern );
    1.88 +
    1.89 +    private:
    1.90 +
    1.91 +        CPosLmCatNameCriteria();
    1.92 +
    1.93 +        void ConstructL();
    1.94 +
    1.95 +        // Prohibit copy constructor
    1.96 +        CPosLmCatNameCriteria( const CPosLmCatNameCriteria& );
    1.97 +        // Prohibit assigment operator
    1.98 +        CPosLmCatNameCriteria& operator= ( const CPosLmCatNameCriteria& );
    1.99 +
   1.100 +    private:
   1.101 +
   1.102 +        HBufC* iSearchPattern;
   1.103 +
   1.104 +    };
   1.105 +
   1.106 +#endif      // CPOSLMCATNAMECRITERIA_H
   1.107 +
   1.108 +