epoc32/include/mw/epos_cposlmsearchcriteria.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 /*
     2 * Copyright (c) 2005-2006 Nokia Corporation and/or its subsidiary(-ies). 
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     5 * under the terms of "Eclipse Public License v1.0"
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
     8 *
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    11 *
    12 * Contributors:
    13 *
    14 * Description:  CPosLmSearchCriteria class
    15 *
    16 */
    17 
    18 
    19 #ifndef CPOSLMSEARCHCRITERIA_H
    20 #define CPOSLMSEARCHCRITERIA_H
    21 
    22 #include <e32base.h>
    23 
    24 /**
    25 *  Abstract base class for landmark search criterion classes.
    26 *
    27 *  Criterion classes are used in @ref CPosLandmarkSearch to specify what to
    28 *  search for. It specifies what criteria the landmark must fulfill to be
    29 *  considered a search match.
    30 *
    31 *  @lib eposlmsearchlib.lib
    32 *  @since S60 3.0
    33 */
    34 class CPosLmSearchCriteria : public CBase
    35     {
    36     public:
    37 
    38         /**
    39         *  Specifies the subclass of the criterion object.
    40         */
    41         enum TCriteriaType
    42             {
    43             ECriteriaArea = 0     /**< subclass CPosLmAreaCriteria */,
    44             ECriteriaText         /**< subclass CPosLmTextCriteria */,
    45             ECriteriaComposite    /**< subclass CPosLmCompositeCriteria */,
    46             ECriteriaCategory     /**< subclass CPosLmCategoryCriteria */,
    47             ECriteriaFindNearest  /**< subclass CPosLmNearestCriteria */,
    48             ECriteriaIdList       /**< subclass CPosLmIdListCriteria */,
    49 
    50             ECriteriaCategoryByName = 100 /**< subclass CPosLmCatNameCriteria */
    51             };
    52 
    53     public:
    54 
    55         /**
    56         * Destructor.
    57         */
    58         virtual ~CPosLmSearchCriteria();
    59 
    60     public:
    61 
    62         /**
    63         * Returns the criterion type.
    64         *
    65         * @returns The criterion type.
    66         */
    67         IMPORT_C TCriteriaType CriteriaType() const;
    68 
    69     protected:
    70 
    71         // C++ constructor.
    72         CPosLmSearchCriteria( TCriteriaType aCriteriaType );
    73 
    74     private:
    75 
    76         // Prohibit copy constructor
    77         CPosLmSearchCriteria( const CPosLmSearchCriteria& );
    78         // Prohibit assigment operator
    79         CPosLmSearchCriteria& operator= ( const CPosLmSearchCriteria& );
    80 
    81     private:
    82 
    83         TCriteriaType iCriteriaType;
    84 
    85     };
    86 
    87 #endif      // CPOSLMSEARCHCRITERIA_H
    88 
    89