1 /*

     2 * Copyright (c) 2005,2006 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:  DefinitionEngine class interface 

    15 *

    16 */

    17 

    18 

    19 #ifndef C_hspsDEFINITIONENGINEINTERFACE_H

    20 #define C_hspsDEFINITIONENGINEINTERFACE_H

    21 

    22 #include <e32base.h>

    23 

    24 // CLASS FORWARD

    25 class RFs;

    26 class ChspsODT;

    27 

    28 

    29 // CLASS DECLARATION

    30 /**

    31  *  Definition Enginen plugin interface class.

    32  *

    33  * @lib hspsdefinitionengineinterface.lib

    34  * @since S60 5.0

    35  * @ingroup group_hspsdefinitionengine

    36  */

    37 class ChspsDefinitionEngineInterface : public CBase

    38     {

    39     public:

    40         struct TError

    41             {

    42             TInt iDefEngError;

    43             TInt iSubComponentError;

    44             };

    45 

    46     public:

    47 	

    48         /**

    49         * Two-phased constructor.

    50         * 

    51         * @since S60 5.0

    52         * @param aPluginId  Name of implementation.

    53         */

    54      	IMPORT_C static ChspsDefinitionEngineInterface* NewL(const TDesC8& aPluginId );

    55         

    56         /**

    57         * Destructor

    58         */

    59         IMPORT_C virtual ~ChspsDefinitionEngineInterface();

    60 

    61 

    62     public: // New functions

    63         /**

    64         * Parses the given XML file. Inserts all nodes to DOM tree,

    65         * parses the CSS file and assignes all properties to the nodes

    66         * @since Series 60 3.1

    67         * @param aFsSession: file server session

    68         * @param aXMLFileName: XML file to parse

    69         * @param ahspsOdt: ODT structure, which contains the DomDocument

    70         * @return: Error code 

    71         */

    72         virtual TError CreateDOM( 

    73             RFs& aFsSession,

    74             const TDesC& aXMLFileName,

    75             ChspsODT& ahspsOdt )=0;

    76 

    77        /**

    78         * Parses the given DTD file. Replaces all entity referencies 

    79         * in the skeleton DOM tree. Returns Localized DOM if it was successfull 

    80         * @since Series 60 3.1

    81         * @param aFsSession: file server session

    82         * @param aDTDFileName: Input DTD file for a certain language

    83         * @param ahspsOdt: Input/Output ODT structure, which contains the DomDocument.

    84         */

    85        virtual void ApplyLanguageL(

    86             RFs& aFsSession,

    87             const TDesC& aDTDFileName,

    88             ChspsODT& ahspsOdt )=0;

    89 

    90 	private:

    91 		TUid iDtorKey;

    92     

    93     };

    94 

    95 #endif      

    96             

    97 // End of File