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