csxhelp/HelpEngine/inc/CSXHMainTopics.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:  CCSXHMainTopics class declaration
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef INC_CSXHMAINTOPICS_H_HEADER_INCLUDED_BC0568C5
       
    20 #define INC_CSXHMAINTOPICS_H_HEADER_INCLUDED_BC0568C5
       
    21 
       
    22 #include "CSXHGenericTOC1.h"
       
    23 #include <apadef.h>
       
    24 
       
    25 class CCSXHHelpDataBase;
       
    26 /** 
       
    27 * @class CCSXHMainTopics
       
    28 * This class has info of TOC1 Objects
       
    29 */
       
    30 class CCSXHMainTopics : public CCSXHGenericTOC1
       
    31     {
       
    32     public:
       
    33 /** 
       
    34 *  @function CCSXHMainTopics
       
    35 *  @since S60 3.2
       
    36 *  Construct a CCSXHMainTopics 
       
    37 *  @param aCoeEnv 	- Control Environment 
       
    38 *  @retrun a CCSXHMainTopics pointer
       
    39 */
       
    40     static CCSXHMainTopics* NewL(const TUid&, const TApaAppCaption& aAppCaption, const TInt32 aPriority = 0);
       
    41 /** 
       
    42 *  @function CCSXHMainTopics
       
    43 *  @since S60 3.2
       
    44 *  Construct a CCSXHMainTopics using two phase construction
       
    45 *  @param aCoeEnv 	- Control Environment 
       
    46 *  @retrun a CCSXHMainTopics pointer
       
    47 */  
       
    48     static CCSXHMainTopics* NewLC(const TUid&,const TApaAppCaption& aAppCaption, const TInt32 aPriority = 0);
       
    49     
       
    50 /** 
       
    51  * @function ~CCSXHMainTopics
       
    52  * @since S60 3.2
       
    53  * Destroy the object and release all memory objects
       
    54  */    
       
    55     ~CCSXHMainTopics();
       
    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 ResetChildList
       
    65 *  @since S60 3.2
       
    66 *  Delete Objects from the Array
       
    67 */    
       
    68     void ResetChildList();
       
    69     
       
    70     protected:
       
    71    
       
    72 /** 
       
    73 *  @function CCSXHMainTopics
       
    74 *  @since S60 3.2
       
    75 *  Construct a CCSXHMainTopics
       
    76 *  @param aUid  - Application Uid
       
    77 *         aName - TOC1 Object Name  
       
    78 */    
       
    79     CCSXHMainTopics(const TUid& aUid, const TDesC& aName, const TInt32 aPriority);
       
    80     	
       
    81     const TUid &iUid;
       
    82     };
       
    83 
       
    84 #endif /* INC_CSXHMAINTOPICS_H_HEADER_INCLUDED_BC0568C5 */