csxhelp/HelpEngine/inc/CSXHContextTopic.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:  CCSXHContextTopic class declaration
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef INC_CSXHCONTEXTTOPIC_H_HEADER_INCLUDED_BC050AFE
       
    20 #define INC_CSXHCONTEXTTOPIC_H_HEADER_INCLUDED_BC050AFE
       
    21 
       
    22 #include "CSXHHelpContentBase.h"
       
    23 
       
    24 class CCSXHHelpDataBase;
       
    25 /** 
       
    26 * @class CCSXHContextTopic
       
    27 * This class is used for Context Sensitivity   
       
    28 */
       
    29 class CCSXHContextTopic : public CCSXHHelpContentBase
       
    30     {
       
    31   public:
       
    32 /** 
       
    33 *  @function NewL
       
    34 *  @since S60 3.2
       
    35 *  Construct a CCSXHContextTopic 
       
    36 *  and return a pointer to the created object
       
    37 *  @param aToc2 	- a toc2 class pointer type casted to database
       
    38 *  @return a CCSXHContextTopic Pointer 
       
    39 */
       
    40 	static CCSXHContextTopic* NewL(CCSXHHelpContentBase* aToc2);
       
    41 /** 
       
    42  * @function ~CCSXHContextTopic
       
    43  * @since S60 3.2
       
    44  * Destroy the object and release all memory objects
       
    45  */  	
       
    46     ~CCSXHContextTopic();
       
    47 /** 
       
    48 *  @function GetViewID
       
    49 *  @since S60 3.2
       
    50 *  Get ViewId to activate the View
       
    51 *  @return View Id
       
    52 */      
       
    53     TUid GetViewID() const;
       
    54 /** 
       
    55 *  @function GetTopic
       
    56 *  @since S60 3.2
       
    57 *  Get the Object HTML / Legacy type cast to Database
       
    58 *  @return View Id
       
    59 */      
       
    60     IMPORT_C CCSXHHelpContentBase* GetTopic();
       
    61 
       
    62   protected:
       
    63 /** 
       
    64 *  @function CCSXHContextTopic
       
    65 *  @since S60 3.2
       
    66 *  Construct a CCSXHContextTopic 
       
    67 *  @param aToc2object 	- a toc2 class pointer type casted to database
       
    68 */  
       
    69   	CCSXHContextTopic(CCSXHHelpContentBase *aToc2object); 
       
    70   
       
    71   protected:
       
    72   	CCSXHHelpContentBase *iToc2;
       
    73 
       
    74   };
       
    75 
       
    76 
       
    77 
       
    78 #endif /* INC_CSXHCONTEXTTOPIC_H_HEADER_INCLUDED_BC050AFE */