homescreenpluginsrv/inc/hspsdefinitionengineinterface.h
author Christian Morlok <symbian.org@christianmorlok.de>
Wed, 07 Apr 2010 14:35:19 +0200
branchv5backport
changeset 54 666a2952b5b3
parent 0 79c6a41cd166
permissions -rw-r--r--
renamed dlls+exe to prevent conflicts with existing files in emulator; changelog attached. * renamed dlls/exe: - aifw.dll to aifw_hs.dll - cputils to cputils_hs - aiidleint.dll to aiidleint_hs.dll - aiutils.dll to aiutils_hs.dll - MenuInterface.dll to MenuInterface_hs.dll - XCFW.dll to XCFW_hs.dll - homescreen.exe to homescreen_hs.exe - ailaunch.exe to ailaunch_hs.exe * new UID for Active Idle (aifw_hs.dll, aiidleint_hs.dll and homescreen.exe): #define AI_UID3_AIFW_COMMON 0xEDFF45C4 (was 0x102750F0 = 271012080) * new UID for cputils_hs.dll: 0xE3E7134E (was 0x20016B7F = 536963967) * new UID for AI Utilities Factory (aiutils_hs.dll): 0xEC55106C (was 0x10281865 = 271063141) * new UID for MenuInterface_hs.dll: 0xEEE24485 (was 0x10210EAB = 270601899) * new UID for XCFW_hs.dll: 0xEB12332F (was 0x10210EA0 = 270601888) * new UID for ailaunch_hs.exe: 0xEF5A047A (was 0x200286E3 = 537036515)

/*
* Copyright (c) 2005,2006 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of "Eclipse Public License v1.0"
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description:  DefinitionEngine class interface 
*
*/


#ifndef C_hspsDEFINITIONENGINEINTERFACE_H
#define C_hspsDEFINITIONENGINEINTERFACE_H

#include <e32base.h>

// CLASS FORWARD
class RFs;
class ChspsODT;


// CLASS DECLARATION
/**
 *  Definition Enginen plugin interface class.
 *
 * @lib hspsdefinitionengineinterface.lib
 * @since S60 5.0
 * @ingroup group_hspsdefinitionengine
 */
class ChspsDefinitionEngineInterface : public CBase
    {
    public:
        struct TError
            {
            TInt iDefEngError;
            TInt iSubComponentError;
            };

    public:
	
        /**
        * Two-phased constructor.
        * 
        * @since S60 5.0
        * @param aPluginId  Name of implementation.
        */
     	IMPORT_C static ChspsDefinitionEngineInterface* NewL(const TDesC8& aPluginId );
        
        /**
        * Destructor
        */
        IMPORT_C virtual ~ChspsDefinitionEngineInterface();


    public: // New functions
        /**
        * Parses the given XML file. Inserts all nodes to DOM tree,
        * parses the CSS file and assignes all properties to the nodes
        * @since Series 60 3.1
        * @param aFsSession: file server session
        * @param aXMLFileName: XML file to parse
        * @param ahspsOdt: ODT structure, which contains the DomDocument
        * @return: Error code 
        */
        virtual TError CreateDOM( 
            RFs& aFsSession,
            const TDesC& aXMLFileName,
            ChspsODT& ahspsOdt )=0;

       /**
        * Parses the given DTD file. Replaces all entity referencies 
        * in the skeleton DOM tree. Returns Localized DOM if it was successfull 
        * @since Series 60 3.1
        * @param aFsSession: file server session
        * @param aDTDFileName: Input DTD file for a certain language
        * @param ahspsOdt: Input/Output ODT structure, which contains the DomDocument.
        */
       virtual void ApplyLanguageL(
            RFs& aFsSession,
            const TDesC& aDTDFileName,
            ChspsODT& ahspsOdt )=0;

	private:
		TUid iDtorKey;
    
    };

#endif      
            
// End of File