csxhelp/inc/CSXHLegacyTopicView.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:  CCSXHLegacyTopicView class declaration
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #include <aknview.h>
       
    20 #include <aknlists.h>
       
    21 
       
    22 class CCSXHLegacyTopicContainer;
       
    23 
       
    24 // CLASS DECLARATION
       
    25 
       
    26 /** 
       
    27 * @class CCSXHLegacyTopicView
       
    28 * This class handles RichTextView of the Csxhelp Application
       
    29 */
       
    30 class CCSXHLegacyTopicView : public CAknView
       
    31     {
       
    32     public:   
       
    33 /** 
       
    34 *  @function NewL
       
    35 *  @since S60 3.2
       
    36 *  Construct a CCSXHLegacyTopicView 
       
    37 *  and return a pointer to the created object
       
    38 *  @param aUid   - View Id
       
    39 *		  aFlags - Resource Id
       
    40 *		  aRect  - TRect Object	
       
    41 *  @return a CCSXHLegacyTopicView Pointer 
       
    42 */
       
    43      
       
    44     static CCSXHLegacyTopicView* NewL(const TUid& aUid, const TInt& 
       
    45 			aFlags,const TRect& aRect);
       
    46 /**
       
    47 * From CAknView
       
    48 * @function DoDeactivate 
       
    49 * de-activation handler
       
    50 *
       
    51 * @since 3.2
       
    52 * @param aPrevViewId ID of previious view.
       
    53 */    
       
    54     void DoDeactivate();
       
    55     
       
    56 /** 
       
    57 *  @function ~CCSXHLegacyTopicView
       
    58 *  @since S60 3.2
       
    59 *  Destroy the object and release all memory objects
       
    60 */
       
    61         virtual ~CCSXHLegacyTopicView();
       
    62     protected:
       
    63 /** 
       
    64 *  @function CCSXHLegacyTopicView
       
    65 *  @since S60 3.2
       
    66 *  Perform the first phase of two phase construction
       
    67 */        CCSXHLegacyTopicView(const TUid&, const TInt&);
       
    68 
       
    69 /** 
       
    70 *  @function ConstructL
       
    71 *  @since S60 3.2
       
    72 *  Perform the second phase construction of a legacytopicview object
       
    73 *  @param aRect the rectangle this view will be drawn to
       
    74 */ 
       
    75        void ConstructL(const TRect& aRect);          
       
    76 
       
    77     public: // Functions from base classes
       
    78  /**
       
    79 * From CAknView, return view id of this view
       
    80 *
       
    81 * @function Id
       
    82 * @since 3.2
       
    83 * @return view id
       
    84 */
       
    85         TUid Id() const;
       
    86 
       
    87 /** 
       
    88  * @function HandleCommandL
       
    89  * @since S60 3.2  
       
    90  * takes care of command handling.
       
    91  * @param aCommand command to be handled
       
    92  */
       
    93         void HandleCommandL(TInt aCommand);  
       
    94         
       
    95 /** 
       
    96  * @function ResourceChangeHdl
       
    97  * @since S60 3.2  
       
    98  * Handler for resource change
       
    99  * @param aType - Type of resource change event
       
   100  */
       
   101      void ResourceChangeHdl(TInt aType);                 
       
   102 
       
   103     protected: // functions from base classes
       
   104 /**
       
   105 * From CAknView
       
   106 * @function DoActivateL 
       
   107 * activation handler
       
   108 *
       
   109 * @since 3.2
       
   110 * @param aPrevViewId ID of previious view.
       
   111 */ 
       
   112         void DoActivateL(const TVwsViewId& aPrevViewId,
       
   113                              TUid /* aCustomMessageId */,
       
   114                              const TDesC8& /* aCustomMessage */);
       
   115                              
       
   116 
       
   117 /** 
       
   118  * @function ViewActivatedL
       
   119  * @since S60 3.2  
       
   120  * Takes any action required when this view is activated. 
       
   121  * Handles this view activation event from view server
       
   122  * @param aPrevViewId  		- Specifies the view previously active.  
       
   123  *		  aCustomMessageId  - Specifies the message type.  
       
   124  *  	  aCustomMessage    - Activation message 
       
   125  */                             
       
   126        void ViewActivatedL(const TVwsViewId& aPrevViewId,
       
   127 	                             TUid aCustomMessageId,
       
   128 	                             const TDesC8& aCustomMessage);
       
   129 	                             
       
   130 /** 
       
   131  * @function ViewActivatedL
       
   132  * @since S60 3.2  
       
   133  * Takes any action required when this view is deactivated. 
       
   134  * Handles this view deactivation event from view server 
       
   135  */
       
   136 	   void ViewDeactivated();
       
   137 
       
   138 
       
   139     private: 
       
   140          
       
   141 		CCSXHLegacyTopicContainer* iTopicContainer;
       
   142 		TVwsViewId iPrevious;
       
   143 		
       
   144 		const TUid& iUid;
       
   145       	const TInt& iAppFlags;
       
   146   
       
   147     };