csxhelp/HelpEngine/inc/CSXHKywdTOC1.h
branchRCL_3
changeset 18 cbffe13eac63
parent 0 1f04cf54edd8
equal deleted inserted replaced
17:12f60d9a73b3 18:cbffe13eac63
       
     1 /*
       
     2 * Copyright (c) 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:  CCSXHKywdTOC1 class declaration
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef INC_CSXHKYWDTOC1_H_HEADER_INCLUDED_BC0568C5
       
    20 #define INC_CSXHKYWDTOC1_H_HEADER_INCLUDED_BC0568C5
       
    21 
       
    22 #include "CSXHGenericTOC1.h"
       
    23 
       
    24 class CCSXHHtmlTOC1;
       
    25 /** 
       
    26 * @class CCSXHLegacyTOC1
       
    27 * This class has the information of keyword TOC1 
       
    28 */
       
    29 class CCSXHKywdTOC1 : public CCSXHGenericTOC1
       
    30     {
       
    31     public:
       
    32 /** 
       
    33 *  @function NewL
       
    34 *  @since S60 3.2
       
    35 *  Construct a CCSXHKywdTOC1 
       
    36 *  and return a pointer to the created object
       
    37 *  @param aName 	- Name of the TOC1
       
    38 *  @return a CCSXHKywdTOC1 Pointer 
       
    39 */     
       
    40 	    static CCSXHKywdTOC1* NewL(const TDesC& aName);
       
    41 /** 
       
    42 *  @function NewLC
       
    43 *  @since S60 3.2
       
    44 *  Construct a CCSXHKywdTOC1 
       
    45 *  and return a pointer to the created object using two phase contruction
       
    46 *  @param aName 	- Name of the TOC1
       
    47 *  @return a CCSXHKywdTOC1 Pointer 
       
    48 */  	    
       
    49     	static CCSXHKywdTOC1* NewLC(const TDesC& aName);
       
    50 /** 
       
    51  * @function ~CCSXHKywdTOC1
       
    52  * @since S60 3.2
       
    53  * Destroy the object and release all memory objects
       
    54  */     	
       
    55   		~CCSXHKywdTOC1();
       
    56 /** 
       
    57 *  @function GetViewID
       
    58 *  @since S60 3.2
       
    59 *  Get ViewId to activate the View
       
    60 *  @return View Id
       
    61 */
       
    62 	    TUid GetViewID() const;
       
    63 /** 
       
    64 *  @function LegacyIndex
       
    65 *  @since S60 3.2
       
    66 *  Get the position
       
    67 *  @return position
       
    68 */	    
       
    69 	    TInt& LegacyIndex();
       
    70 /** 
       
    71 *  @function AppendHtmlTOC1L
       
    72 *  @since S60 3.2
       
    73 *  Insert html toc1 object
       
    74 *  @param atoc1 - html toc1 class pointer
       
    75 */	    
       
    76 	    void AppendHtmlTOC1L(CCSXHHtmlTOC1* aToc1);
       
    77 
       
    78 /** 
       
    79 *  @function GetHtmlTOC1List
       
    80 *  @since S60 3.2
       
    81 *  Get the Array
       
    82 *  @return pointer to the Array of html toc1 objects
       
    83 */	    
       
    84 	    RPointerArray<CCSXHHtmlTOC1>* GetHtmlTOC1List(); 
       
    85   	
       
    86     protected:
       
    87 /** 
       
    88 *  @function CCSXHKywdTOC1
       
    89 *  @since S60 3.2
       
    90 *  Construct a CCSXHKywdTOC1
       
    91 *  @param aName  - kywd toc1 name
       
    92 */     
       
    93     	CCSXHKywdTOC1(const TDesC& aName);
       
    94 /** 
       
    95 *  @function InitChildList
       
    96 *  @since S60 3.2
       
    97 *  Allocate Memory for toc1htmllist array
       
    98 */     
       
    99        	void InitChildList();	
       
   100   	private:	
       
   101        	TInt iLegacyIndex;//Needed for getting the TOC2 kywd legacy contents
       
   102 		RPointerArray<CCSXHHtmlTOC1> *iTOC1HtmlList; //Needed for getting the TOC2 kywd HTML contents
       
   103      	
       
   104     };
       
   105     
       
   106  
       
   107     
       
   108 #endif /* INC_CSXHKYWDTOC1_H_HEADER_INCLUDED_BC0568C5 */