csxhelp/HelpEngine/inc/CSXHLegacyTOC2.h
changeset 0 1f04cf54edd8
equal deleted inserted replaced
-1:000000000000 0:1f04cf54edd8
       
     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:  CCSXHLegacyTOC2 class declaration
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef INC_CSXHLEGACYTOC2_H_HEADER_INCLUDED_BC0535B9
       
    20 #define INC_CSXHLEGACYTOC2_H_HEADER_INCLUDED_BC0535B9
       
    21 
       
    22 #include "CSXHGenericTOC2.h"
       
    23 
       
    24 class CCSXHGenericTOC1;
       
    25 class CCSXHLegacyTOC1;
       
    26 /** 
       
    27 * @class CCSXHLegacyTOC2
       
    28 * This class has the information of Legacy TOC2 Info
       
    29 */
       
    30 class CCSXHLegacyTOC2 : public CCSXHGenericTOC2
       
    31     {
       
    32     public:
       
    33 /** 
       
    34 *  @function NewL
       
    35 *  @since S60 3.2
       
    36 *  Construct a CCSXHLegacyTOC2 
       
    37 *  and return a pointer to the created object
       
    38 *  @param aParent   - TOC1 Object
       
    39 *		  aName 	- Name of the TOC2 
       
    40 *		  aKey  	- ETrue for KeywordTopic, EFalse otherwise
       
    41 *  @return a CCSXHLegacyTOC2 Pointer 
       
    42 */ 
       
    43     static CCSXHLegacyTOC2* NewL(CCSXHGenericTOC1 *aParent,const TDesC&
       
    44     aName,TBool aKey=EFalse);
       
    45 
       
    46 /** 
       
    47 *  @function NewLC
       
    48 *  @since S60 3.2
       
    49 *  Construct a CCSXHLegacyTOC2 
       
    50 *  and return a pointer to the created object using two phase constuction
       
    51 *  @param aParent   - TOC1 Object
       
    52 *		  aName 	- Name of the TOC2 
       
    53 *		  aKey  	- ETrue for KeywordTopic, EFalse otherwise
       
    54 *  @return a CCSXHLegacyTOC2 Pointer 
       
    55 */     
       
    56     static CCSXHLegacyTOC2* NewLC(CCSXHGenericTOC1 *aParent,const TDesC& 
       
    57     aName,TBool aKey=EFalse);
       
    58 
       
    59 /** 
       
    60 *  @function GetTopicContentL
       
    61 *  @since S60 3.2
       
    62 *  Get the topic to be displayed in Richtext format
       
    63 *  @return RichText Pointer
       
    64 */    
       
    65     IMPORT_C TAny* GetTopicContentL();
       
    66 
       
    67 /** 
       
    68 *  @function GetViewID
       
    69 *  @since S60 3.2
       
    70 *  Get ViewId to activate the View
       
    71 *  @return View Id
       
    72 */       	
       
    73     TUid GetViewID() const;
       
    74     
       
    75 /** 
       
    76 *  @function GetLegacyParent
       
    77 *  @since S60 3.2
       
    78 *  Get Parent Object
       
    79 *  @return TOC1 Object(Parent) for present TOC2 Object
       
    80 */    
       
    81     IMPORT_C  CCSXHLegacyTOC1* GetLegacyParent();
       
    82 		
       
    83 	private:
       
    84 /** 
       
    85 *  @function CCSXHLegacyTOC2
       
    86 *  @since S60 3.2
       
    87 *  Construct a CCSXHLegacyTOC2 
       
    88 *  @param aRect - TRect Object
       
    89 *  @param aParent   - TOC1 Object
       
    90 *		  aName 	- Name of the TOC2 
       
    91 *		  aKey  	- ETrue for KeywordTopic, EFalse otherwise
       
    92 */	
       
    93 		CCSXHLegacyTOC2(CCSXHGenericTOC1 *aParent, const TDesC& aName,TBool aKey);
       
    94 		
       
    95 		TBool iKeyWordTopic;
       
    96   };
       
    97 
       
    98 
       
    99 
       
   100 #endif /* INC_CSXHLEGACYTOC2_H_HEADER_INCLUDED_BC0535B9 */