csxhelp/HelpEngine/inc/CSXHHTMLContentParser.h
branchRCL_3
changeset 5 d06b1526f62c
parent 0 1f04cf54edd8
child 10 930c2f269b74
equal deleted inserted replaced
1:27f5851bd5a5 5:d06b1526f62c
    18 
    18 
    19 #ifndef __CCSXHHTMLCONTENTPARSER_H__
    19 #ifndef __CCSXHHTMLCONTENTPARSER_H__
    20 #define __CCSXHHTMLCONTENTPARSER_H__
    20 #define __CCSXHHTMLCONTENTPARSER_H__
    21 
    21 
    22 #include "CSXHGenericTOC1.h"
    22 #include "CSXHGenericTOC1.h"
       
    23 #include "coehelp.h"
    23 #include <f32file.h>
    24 #include <f32file.h>
    24 #include <barsc.h> 
    25 #include <barsc.h> 
    25 #include <featurecontrol.h>
    26 #include <featurecontrol.h>
    26 
    27 
    27  
    28  
    35 class CCSXHHelpContentBase;
    36 class CCSXHHelpContentBase;
    36 class CCSXHGenericTOC2;
    37 class CCSXHGenericTOC2;
    37 class MSenContentHandlerClient;
    38 class MSenContentHandlerClient;
    38 class CCSXHXMLParseHandler_Kywd;
    39 class CCSXHXMLParseHandler_Kywd;
    39 class CCSXHRuntimeIndexing;
    40 class CCSXHRuntimeIndexing;
       
    41 class CCSXHXMLParseHandler_MetaFile;
    40 /**
    42 /**
    41 *  CCSXHHTMLContentParser class.
    43 *  CCSXHHTMLContentParser class.
    42 *  This class is used to parse XML files & generate Html data
    44 *  This class is used to parse XML files & generate Html data
    43 *  @lib euser.lib SenXml.lib XMLFRAMEWORK.lib	ezip.lib HLPMODEL.LIB
    45 *  @lib euser.lib SenXml.lib XMLFRAMEWORK.lib	ezip.lib HLPMODEL.LIB
    44 *  @since 3.2
    46 *  @since 3.2
   129 *  @param akywdtoc1	- keyword toc1 class pointer
   131 *  @param akywdtoc1	- keyword toc1 class pointer
   130 */		
   132 */		
   131 		void GenerateTOC2ListForKeywordSearchL(CCSXHHelpDataBase* aDataBase,
   133 		void GenerateTOC2ListForKeywordSearchL(CCSXHHelpDataBase* aDataBase,
   132 										CCSXHKywdTOC1* akywdtoc1);
   134 										CCSXHKywdTOC1* akywdtoc1);
   133 /** 
   135 /** 
   134 *  @function GetContextTopic
   136 *  @function GetContextTopicL
   135 *  @since S60 3.2
   137 *  @since S60 3.2
   136 *  Get the help Context object
   138 *  Get the help Context object
   137 *  @param aContext - Help context object
   139 *  @param aContextName - Help context object
   138 *  @return database class pointer 
   140 *  @param aUid - Help content UID
   139 */		
   141 *  @return Help content class pointer 
   140 		CCSXHHelpContentBase* GetContextTopic(const TUid &aUid, const TDesC &contextName);
   142 */		
       
   143 		CCSXHHelpContentBase* GetContextTopicL(CCSXHHelpDataBase *aDataBase, 
       
   144 				                        TUid &aUid, TCoeContextName &aContextName);
   141 /** 
   145 /** 
   142 *  @function GetHtmlTopicForUrlL
   146 *  @function GetHtmlTopicForUrlL
   143 *  @since S60 3.2
   147 *  @since S60 3.2
   144 *  Get the toc2 object in order to get Content
   148 *  Get the toc2 object in order to get Content
   145 *  @param  aurl - Full File Path
   149 *  @param  aurl - Full File Path
   156 */		
   160 */		
   157 		TBool IsUidCategoryPresent(const TUid& aUid);
   161 		TBool IsUidCategoryPresent(const TUid& aUid);
   158 		
   162 		
   159 		
   163 		
   160 		void InsertHTMLToc1L(const TDesC &appUidName,const TDesC &appName,const TInt& aDrive,
   164 		void InsertHTMLToc1L(const TDesC &appUidName,const TDesC &appName,const TInt& aDrive,
   161 		                        CCSXHHelpDataBase* aDataBase,const TDesC &FeatureIds );
   165 		                        CCSXHHelpDataBase* aDataBase, const TDesC &FeatureIds, TInt32 aPriority);
   162 		
   166 		
   163 /** 
   167 /** 
   164 *  @function GetHTMLToc1
   168 *  @function GetHTMLToc1
   165 *  @since S60 3.2
   169 *  @since S60 3.2
   166 *  Get the HTML TOC1 object
   170 *  Get the HTML TOC1 object
   209 *		  aDrive	   - Drive Number
   213 *		  aDrive	   - Drive Number
   210 *		  aXMLParser   - XMLParserhandler pointer		
   214 *		  aXMLParser   - XMLParserhandler pointer		
   211 */
   215 */
   212 		void ScanAndParseXMLfileToCreateTOC1ObjectL(RFs& aFileSession,CDirScan* ascanner,
   216 		void ScanAndParseXMLfileToCreateTOC1ObjectL(RFs& aFileSession,CDirScan* ascanner,
   213 												   CCSXHHelpDataBase* aDataBase,
   217 												   CCSXHHelpDataBase* aDataBase,
   214 												   const TInt& aDrive,CCSXHXMLParseHandler* aXMLParser);		
   218 												   const TInt& aDrive,
       
   219 												   CCSXHXMLParseHandler_MetaFile* aXMLParser);		
       
   220 
       
   221 
       
   222 		
       
   223 		TBool IsRomBasedContentL( RFs& FileSession, const TDesC &aUid );
   215 /** 
   224 /** 
   216 *  @function HandleMasterMetaFileL(
   225 *  @function HandleMasterMetaFileL(
   217 *  @since S60 3.2
   226 *  @since S60 3.2
   218 *  perform the second phase construction
   227 *  perform the second phase construction
   219 *  @param aFileSession - FileSession
   228 *  @param aFileSession - FileSession
   222 *         aPrevHandler  - Previous Content Handler
   231 *         aPrevHandler  - Previous Content Handler
   223 *  @return  ETrue if handled, EFalse otherwise
   232 *  @return  ETrue if handled, EFalse otherwise
   224 */
   233 */
   225 	    TBool HandleMasterMetaFileL(CCSXHHelpDataBase* aDataBase, 
   234 	    TBool HandleMasterMetaFileL(CCSXHHelpDataBase* aDataBase, 
   226 	        TChar& aDrive, MSenContentHandlerClient *aPrevHandler);
   235 	        TChar& aDrive, MSenContentHandlerClient *aPrevHandler);
       
   236 
       
   237 /** 
       
   238 *  @function IsRedirectedL(
       
   239 *  @param aDatabase	    - Database pointer
       
   240 *		  aPath	        - Context root directory
       
   241 *		  aUid          - App uid
       
   242 *         aContextName  - file name
       
   243 *  @return  ETrue if the context is redirected successfully, EFalse otherwise
       
   244 */
       
   245 	    TBool IsRedirectedL(CCSXHHelpDataBase *aDataBase, 
       
   246 	        			const TDesC &aPath, TUid &aUid, TCoeContextName &aContextName);
   227 /** 
   247 /** 
   228 *  @function HandleMasterKeywordFileL(
   248 *  @function HandleMasterKeywordFileL(
   229 *  @since S60 3.2
   249 *  @since S60 3.2
   230 *  parse makster keywords file
   250 *  parse makster keywords file
   231 *  @param aDatabase	   - Database pointer
   251 *  @param aDatabase	   - Database pointer