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