1 xmlengnodefilter.h

     1 /*

     2 * Copyright (c) 2004-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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:       Node filter interface

    15 *

    16 */

    17 

    18 

    19 

    20 

    21 

    22 

    23 

    24 #ifndef XMLENGINE_NODEFILTER_H_INCLUDED

    25 #define XMLENGINE_NODEFILTER_H_INCLUDED

    26 

    27 #include <e32base.h>

    28 

    29 class TXmlEngNode;

    30 

    31 /** 

    32  * Results that can be returned by node filter

    33  */

    34 enum TXmlEngNodeFilterResult

    35     {

    36     EAccept = 1,

    37     EReject = 2,

    38     ESkip = 3,

    39     ESkipContents = 4  /** non-standard feature */

    40     }; 

    41 

    42 /** 

    43  * Interface of nodes filter class

    44  *

    45  * @see http://www.w3.org/TR/2000/REC-DOM-Level-2-Traversal-Range-20001113/traversal.html#Traversal-NodeFilter

    46  *

    47  * @since S60 v3.1

    48  */

    49 class MXmlEngNodeFilter

    50     {

    51 public:

    52     /** 

    53      * Check if node is accepted.

    54      *

    55      * @since S60 v3.1

    56      * @param aNode Node to check

    57      * @return Node filter result

    58      */ 

    59     virtual TXmlEngNodeFilterResult AcceptNode(TXmlEngNode aNode) = 0;    

    60     };

    61 

    62 

    63 #endif /* XMLENGINE_NODEFILTER_H_INCLUDED */