csxhelp/HelpEngine/inc/CSXHHelpDataBase.h
branchRCL_3
changeset 5 d06b1526f62c
parent 0 1f04cf54edd8
equal deleted inserted replaced
1:27f5851bd5a5 5:d06b1526f62c
    49 *  Construct a CCSXHHelpDataBase 
    49 *  Construct a CCSXHHelpDataBase 
    50 *  and return a pointer to the created object
    50 *  and return a pointer to the created object
    51 *  @param aCoeEnv 	- Control Environment
    51 *  @param aCoeEnv 	- Control Environment
    52 *  @return a CCSXHHelpDataBase Pointer 
    52 *  @return a CCSXHHelpDataBase Pointer 
    53 */
    53 */
    54     IMPORT_C static CCSXHHelpDataBase* NewL(CCoeEnv* aCoeEnv,const TApaAppCaption& aAppCaption);
    54     IMPORT_C static CCSXHHelpDataBase* NewL(CCoeEnv* aCoeEnv,const TApaAppCaption& aAppCaption, const TApaAppCaption& aAppHelpTopic);
    55 /** 
    55 /** 
    56 *  @function NewLC
    56 *  @function NewLC
    57 *  @since S60 3.2
    57 *  @since S60 3.2
    58 *  Construct a CCSXHHelpDataBase 
    58 *  Construct a CCSXHHelpDataBase 
    59 *  and return a pointer to the created object using two phase construction
    59 *  and return a pointer to the created object using two phase construction
    60 *  @param aCoeEnv 	- Control Environment
    60 *  @param aCoeEnv 	- Control Environment
    61 *  @return a CCSXHHelpDataBase Pointer 
    61 *  @return a CCSXHHelpDataBase Pointer 
    62 */
    62 */
    63     static CCSXHHelpDataBase* NewLC(CCoeEnv *aCoeEnv,const TApaAppCaption& aAppCaption);
    63     static CCSXHHelpDataBase* NewLC(CCoeEnv *aCoeEnv,const TApaAppCaption& aAppCaption, const TApaAppCaption& aAppHelpTopic);
    64 
    64 
    65 /** 
    65 /** 
    66 *  @function GetInstance
    66 *  @function GetInstance
    67 *  @since S60 3.2
    67 *  @since S60 3.2
    68 *  Get the instance of database class
    68 *  Get the instance of database class
    89 *  Get the instance of keyword toc1
    89 *  Get the instance of keyword toc1
    90 *  @return toc1 pointer 
    90 *  @return toc1 pointer 
    91 */  
    91 */  
    92     IMPORT_C CCSXHGenericTOC1* GetKywdTopics();
    92     IMPORT_C CCSXHGenericTOC1* GetKywdTopics();
    93 /** 
    93 /** 
       
    94 *  @function GetAppHelpsTopics
       
    95 *  @since S60 5.2
       
    96 *  Get the instance of application (custom) helps toc1
       
    97 *  @return toc1 pointer 
       
    98 */  
       
    99     IMPORT_C CCSXHGenericTOC1* GetAppHelpsTopics();
       
   100 /** 
    94 *  @function ClearAllTOC1Contents
   101 *  @function ClearAllTOC1Contents
    95 *  @since S60 3.2
   102 *  @since S60 3.2
    96 *  Delete all the objects from the Array
   103 *  Delete all the objects from the Array
    97 */   
   104 */   
    98     IMPORT_C void ClearAllTOC1Contents();
   105     IMPORT_C void ClearAllTOC1Contents();
   223 *  @function CCSXHHelpDataBase
   230 *  @function CCSXHHelpDataBase
   224 *  @since S60 3.2
   231 *  @since S60 3.2
   225 *  Construct a CCSXHHelpDataBase
   232 *  Construct a CCSXHHelpDataBase
   226 *  @param aCoeEnv  - Control Environment
   233 *  @param aCoeEnv  - Control Environment
   227 */
   234 */
   228     CCSXHHelpDataBase(CCoeEnv* aCoeEnv,const TApaAppCaption& aAppCaption);
   235     CCSXHHelpDataBase(CCoeEnv* aCoeEnv,const TApaAppCaption& aAppCaption, const TApaAppCaption& aAppHelpTopic);
   229 
   236 
   230 /** 
   237 /** 
   231 *  @function GetContextTopicL
   238 *  @function GetContextTopicL
   232 *  @since S60 3.2
   239 *  @since S60 3.2
   233 *  Get the topic for the Context
   240 *  Get the topic for the Context
   239     // List of TOC1 entries
   246     // List of TOC1 entries
   240     CCSXHMainTopics *iMainTOC1;
   247     CCSXHMainTopics *iMainTOC1;
   241     // List of keyword entries
   248     // List of keyword entries
   242     CCSXHKywdTopics *iKywdTOC1;
   249     CCSXHKywdTopics *iKywdTOC1;
   243     
   250     
       
   251     CCSXHMainTopics* iAppHelpsToc;
       
   252     
   244     
   253     
   245     CCSXHHTMLContentParser *iHTMLContentParser;
   254     CCSXHHTMLContentParser *iHTMLContentParser;
   246     CCSXHLegacyContentParser *iLegacyContentParser;
   255     CCSXHLegacyContentParser *iLegacyContentParser;
   247     
   256     
   248 	CCoeEnv *iCoeEnv;
   257 	CCoeEnv *iCoeEnv;
   251 	
   260 	
   252 	MCSXHKywdBuilder *iKwydBuilder;
   261 	MCSXHKywdBuilder *iKwydBuilder;
   253 	
   262 	
   254 	TApaAppCaption iAppCaption;
   263 	TApaAppCaption iAppCaption;
   255 	
   264 	
       
   265 	TApaAppCaption  iAppHelpTopic;
   256 	TInt iKeywordSearchCount;
   266 	TInt iKeywordSearchCount;
   257 	
   267 	
   258     };
   268     };
   259 
   269 
   260 
   270