idlehomescreen/inc/mxndomvisitor.h
changeset 0 f72a12da539e
equal deleted inserted replaced
-1:000000000000 0:f72a12da539e
       
     1 /*
       
     2 * Copyright (c) 2002-2004 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:  Visitor class interface 
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef MXN_DOM_VISITOR_H
       
    21 #define MXN_DOM_VISITOR_H
       
    22 
       
    23 // CLASS FORWARD
       
    24 class CXnDomNode;
       
    25 
       
    26 // CLASS DECLARATION
       
    27 
       
    28 /**
       
    29 *  Visitor class modifies DOM node element's data.
       
    30 *
       
    31 *  @lib xndomvisitor.dll
       
    32 *  @since Series 60 3.1
       
    33 */
       
    34 class MXnDomVisitor
       
    35     {
       
    36     public: // New functions
       
    37         
       
    38         /**
       
    39         * Check in-memory plugin version.
       
    40         * @return ETrue if version match
       
    41         */
       
    42         virtual TBool IsVersion( const TDesC8& aVersion )=0;
       
    43         
       
    44         /**
       
    45         * Modifies data
       
    46         * @param aData Data to modify
       
    47         */
       
    48         virtual void ModifyDataL( CXnDomNode& aNode )=0;
       
    49         
       
    50         /**
       
    51         * Sets element content type (TContentType) from XnDomNode.h
       
    52         * @param aNode Node to modify
       
    53         */
       
    54         virtual void SetElementTypeL( CXnDomNode& aNode )=0;
       
    55         
       
    56         /**
       
    57         * Ecom passes a destructor key at the time when plugin is created
       
    58         * and requires that key when plugin is destroyed.
       
    59         * @param aKey ECom required destructor key
       
    60         */ 
       
    61         virtual void SetDtorKey( const TUid aDtorKey )=0;
       
    62         
       
    63         /**
       
    64         * Release resources
       
    65         */
       
    66         virtual void Release()=0;
       
    67     
       
    68     protected:
       
    69         /**
       
    70         * Plugin can only be destroyed by calling Release().
       
    71         */
       
    72         ~MXnDomVisitor(){};
       
    73 
       
    74     };
       
    75 
       
    76 #endif      // MXN_DOM_VISITOR_H  
       
    77             
       
    78 // End of File