1 /*

     2 * Copyright (c) 2007-2007 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:  Class header for MWsfWlanInfoSortingFilterVisitor

    15 *

    16 */

    17 

    18 

    19 

    20 #ifndef M_WSFWLANINFOSORTINGFILTERVISITOR_H

    21 #define M_WSFWLANINFOSORTINGFILTERVISITOR_H

    22 

    23 

    24 //  EXTERNAL INCLUDES

    25 #include <e32base.h>

    26 

    27 

    28 //  FORWARD DECLARATIONS

    29 class TWsfWlanInfo;

    30 class CWsfWlanInfoArray;

    31 

    32 

    33 //  CLASS DEFINITION

    34 /**

    35  * Interface class for common filtering actions

    36  *

    37  * @since S60 5.0

    38  */

    39 class MWsfWlanInfoSortingFilterVisitor 

    40     {

    41     public:

    42     

    43         /**

    44         * Do comparing between these two entries

    45         * @since S60 5.0

    46         * @param aInfoLeft Left element

    47         * @param aInfoRight Right element

    48         * @return Negative if aInfoLeft is smaller tha aInfoRight,

    49         *         zero if the entries are equal,

    50         *         positive if the aInfoLeft is greater than aInfoRight

    51         */

    52         virtual TInt Compare( const TWsfWlanInfo& aInfoLeft, 

    53                               const TWsfWlanInfo& aInfoRight ) = 0;

    54 

    55         /**

    56         * Check if the entry matches to filter rules and carry out additional

    57         * operations if needed.

    58         * @since S60 5.0

    59         * @param aInfoLeft The element to be checked

    60         * @return ETrue if the item matches the rules

    61         */

    62         virtual TBool SetupOnRuleMatch( TWsfWlanInfo& aInfoLeft ) = 0;

    63     

    64 

    65         /**

    66         * Handle filter match 

    67         * @since S60 5.0

    68         * @param aFilterEntry The element in question

    69         */ 

    70         virtual void MarkMatchedFilterL( TWsfWlanInfo& aFilterEntry ) = 0;

    71 

    72         /**

    73         * Edit filter definitions

    74         * @since S60 5.0

    75         * @param aInfoArray The element in question

    76         */

    77         virtual void EditFilterDefsL( CWsfWlanInfoArray& aInfoArray ) = 0;

    78         

    79         /**

    80         * Read the filter defintions to filter

    81         * @since S60 5.0

    82         */

    83         virtual void ReadFilterDefsL() = 0;

    84     };

    85     

    86 

    87 

    88 

    89 #endif // M_WSFWLANINFOSORTINGFILTERVISITOR_H

    90