williamr@2: /*
williamr@2: * Copyright (c) 2005-2006 Nokia Corporation and/or its subsidiary(-ies). 
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@2: * 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
williamr@2: * which accompanies this distribution, and is available
williamr@2: * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description:  CPosLmCatNameCriteria class
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: #ifndef CPOSLMCATNAMECRITERIA_H
williamr@2: #define CPOSLMCATNAMECRITERIA_H
williamr@2: 
williamr@2: #include <e32base.h>
williamr@2: #include "EPos_CPosLmSearchCriteria.h"
williamr@2: 
williamr@2: /**
williamr@2: *  Criterion for searching landmark categories with a certain name.
williamr@2: *
williamr@2: *  Wild-card characters are supported.
williamr@2: *
williamr@2: *  The client specifies the search pattern and starts the search using
williamr@2: *  @ref CPosLandmarkSearch. The search returns all categories which
williamr@2: *  match the search pattern.
williamr@2: *
williamr@2: *  This criterion is only valid when searching for landmark categories, i.e. if
williamr@2: *  it is passed to @p CPosLandmarkSearch::StartLandmarkSearchL, the function
williamr@2: *  will fail with error code @p KErrArgument.
williamr@2: *
williamr@2: *  @lib eposlmsearchlib.lib
williamr@2: *  @since S60 3.0
williamr@2: */
williamr@2: class CPosLmCatNameCriteria : public CPosLmSearchCriteria
williamr@2:     {
williamr@2:     public:
williamr@2: 
williamr@2:         /**
williamr@2:         * Two-phased constructor.
williamr@2:         * @returns A new instance of this class.
williamr@2:         */
williamr@2:         IMPORT_C static CPosLmCatNameCriteria* NewLC();
williamr@2: 
williamr@2:         /**
williamr@2:         * Destructor.
williamr@2:         */
williamr@2:         virtual ~CPosLmCatNameCriteria();
williamr@2: 
williamr@2:     public:
williamr@2: 
williamr@2:         /**
williamr@2:         * Retrieves the search pattern.
williamr@2:         *
williamr@2:         * @return The category name search pattern.
williamr@2:         */
williamr@2:         IMPORT_C TPtrC SearchPattern() const;
williamr@2: 
williamr@2:         /**
williamr@2:         * Sets the search pattern.
williamr@2:         *
williamr@2:         * A non-empty search pattern must be set, otherwise
williamr@2:         * @ref CPosLandmarkSearch::StartCategorySearchL will leave with error
williamr@2:         * code @p KErrArgument.
williamr@2:         *
williamr@2:         * The search is case insensitive.
williamr@2:         *
williamr@2:         * Wild-card characters "?" and "*" are supported in the search string.
williamr@2:         * "?" matches a single occurrence of any character and "*" matches
williamr@2:         * zero or more consecutive occurrences of any characters.
williamr@2:         *
williamr@2:         * @param[in] aSearchPattern The pattern used to find categories.
williamr@2:         *
williamr@2:         * @leave KErrArgument The search pattern is longer than 
williamr@2:         *   @p KPosLmMaxCategoryNameLength.
williamr@2:         */
williamr@2:         IMPORT_C void SetSearchPatternL( const TDesC& aSearchPattern );
williamr@2: 
williamr@2:     private:
williamr@2: 
williamr@2:         CPosLmCatNameCriteria();
williamr@2: 
williamr@2:         void ConstructL();
williamr@2: 
williamr@2:         // Prohibit copy constructor
williamr@2:         CPosLmCatNameCriteria( const CPosLmCatNameCriteria& );
williamr@2:         // Prohibit assigment operator
williamr@2:         CPosLmCatNameCriteria& operator= ( const CPosLmCatNameCriteria& );
williamr@2: 
williamr@2:     private:
williamr@2: 
williamr@2:         HBufC* iSearchPattern;
williamr@2: 
williamr@2:     };
williamr@2: 
williamr@2: #endif      // CPOSLMCATNAMECRITERIA_H
williamr@2: 
williamr@2: