csxhelp/HelpEngine/inc/CSXHLegacyTOC1.h
branchRCL_3
changeset 17 12f60d9a73b3
parent 16 0d1adf67ec1b
child 18 cbffe13eac63
equal deleted inserted replaced
16:0d1adf67ec1b 17:12f60d9a73b3
     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:  CCSXHLegacyTOC1 class declaration
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef INC_CSXHLEGACYTOC1_H_HEADER_INCLUDED_BC050894
       
    20 #define INC_CSXHLEGACYTOC1_H_HEADER_INCLUDED_BC050894
       
    21 
       
    22 #include "CSXHGenericTOC1.h"
       
    23 
       
    24 class CCSXHGenericContentParser;
       
    25 class CCSXHHelpDataBase;
       
    26 /** 
       
    27 * @class CCSXHLegacyTOC1
       
    28 * This class has the information of Legacy TOC1 
       
    29 */
       
    30 class CCSXHLegacyTOC1 : public CCSXHGenericTOC1
       
    31     {
       
    32     public:
       
    33 /** 
       
    34 *  @function NewL
       
    35 *  @since S60 3.2
       
    36 *  Construct a CCSXHLegacyTOC1 
       
    37 *  and return a pointer to the created object
       
    38 *  @param aName 	- Name of the TOC1
       
    39 *  @return a CCSXHLegacyTOC1 Pointer 
       
    40 */    
       
    41     static CCSXHLegacyTOC1* NewL(const TDesC& aName);
       
    42     
       
    43 /** 
       
    44 *  @function NewLC
       
    45 *  @since S60 3.2
       
    46 *  Construct a CCSXHLegacyTOC1 
       
    47 *  and return a pointer to the created object using two phase contruction
       
    48 *  @param aName 	- Name of the TOC1
       
    49 *  @return a CCSXHLegacyTOC1 Pointer 
       
    50 */      
       
    51     static CCSXHLegacyTOC1* NewLC(const TDesC& aName);
       
    52      
       
    53 /** 
       
    54 *  @function GetViewID
       
    55 *  @since S60 3.2
       
    56 *  Get ViewId to activate the View
       
    57 *  @return View Id
       
    58 */ 
       
    59     TUid GetViewID() const;
       
    60     
       
    61 /** 
       
    62 *  @function GetContextTopic
       
    63 *  @since S60 3.2
       
    64 *  Get toc2 Object 
       
    65 *  @return CCSXHHelpContentBase (Leagcytoc2) class Pointer
       
    66 */  
       
    67     CCSXHHelpContentBase* GetContextTopic(const TDesC &aContextName);
       
    68 
       
    69     private: 	
       
    70 /** 
       
    71 *  @function CCSXHLegacyTOC1
       
    72 *  @since S60 3.2
       
    73 *  Construct a CCSXHLegacyTOC1 
       
    74 */    
       
    75     	CCSXHLegacyTOC1(const TDesC& aName);
       
    76 
       
    77 /** 
       
    78 *  @function InitChildList
       
    79 *  @since S60 3.2
       
    80 *  Allocates Memory in order to store Objects
       
    81 */    
       
    82     	void InitChildList();
       
    83     
       
    84     };
       
    85 
       
    86 
       
    87 
       
    88 #endif /* INC_CSXHLEGACYTOC1_H_HEADER_INCLUDED_BC050894 */