1 /*

     2 * Copyright (c) 2005 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: Header declaration

    15 *

    16 */

    17 

    18 

    19 

    20 

    21 

    22 

    23 

    24 

    25 

    26 #ifndef M_SEN_FILTER_COLLECTOR_H

    27 #define M_SEN_FILTER_COLLECTOR_H

    28 

    29 

    30 // INCLUDES

    31 

    32 #include <e32base.h>

    33 

    34 #include "SenBaseFragment.h"

    35 #include <SenXmlElement.h> // check if this include is needed(?)

    36 

    37 //#include "SenAttributes.h"

    38 

    39 // CONSTANTS

    40 

    41 // FORWARD DECLARATIONS

    42 

    43 // CLASS DEFINITIONS

    44 

    45 

    46 /**

    47  * @author lewontin

    48  *

    49  * The interface to be implemented by objects that want to collect filter results.

    50  */

    51 

    52 

    53 class MSenFilterCollector 

    54 {

    55 public:

    56     /**PutL

    57      * Initialize the collector:

    58      * This is called before the collector starts collecting. Use this

    59      * to initialize the data structure into which elements are collected.

    60      */ 

    61     virtual void Initialize() = 0;

    62 

    63     /**

    64      * Collect element tag:

    65      * Called when an element is first encountered (i.e. before any of the

    66      * element's content has been parsed.) Use this to allocate a data type

    67      * that represents an element with other element content. 

    68      * 

    69      */

    70     virtual void PutElementL(const TDesC8& aName, 

    71                              const RAttributeArray& aAttributes) = 0;

    72 

    73     /**

    74      * Collect element text content:

    75      * Called when an element's content has been fully parsed. This provides the

    76      * text content as a "property", i.e. an elementname/value pair.

    77      */

    78     virtual void PutL(const TDesC8& aName, 

    79                       const TDesC8& aValue) = 0;

    80 

    81 

    82 };

    83 

    84 #endif // M_SEN_FILTER_COLLECTOR_H

    85