csxhelp/inc/CSXHGenericView.h
branchRCL_3
changeset 18 cbffe13eac63
equal deleted inserted replaced
17:12f60d9a73b3 18:cbffe13eac63
       
     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:  CCSXHGenericView class declaration
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef INC_CSXHGENERICVIEW_H_HEADER_INCLUDED_BC03B1F7
       
    20 #define INC_CSXHGENERICVIEW_H_HEADER_INCLUDED_BC03B1F7
       
    21 
       
    22 #include <aknview.h>
       
    23 #include <e32std.h> 
       
    24 
       
    25 //forward declarations
       
    26 class CCSXHGenericContainer;
       
    27 
       
    28 /** 
       
    29 * @class CCSXHGenericView
       
    30 * This class List View of the Csxhelp Application
       
    31 */
       
    32 class CCSXHGenericView : public CAknView
       
    33     {
       
    34     public:
       
    35 /** 
       
    36 *  @function NewL
       
    37 *  @since S60 3.2
       
    38 *  Construct a CCSXHGenericContainer 
       
    39 *  and return a pointer to the created object
       
    40 *  @param aUid   - View Id
       
    41 *		  aFlags - Resource Id
       
    42 *		  aRect  - TRect Object	
       
    43 *  @return a CCSXHGenericView Pointer 
       
    44 */      
       
    45      	static CCSXHGenericView* NewL(const TUid& aUid, const TInt& aFlags);
       
    46 
       
    47 /** 
       
    48 *  @function ~CCSXHGenericView
       
    49 *  @since S60 3.2
       
    50 *  Destroy the object and release all memory objects
       
    51 */
       
    52 	   	~CCSXHGenericView();
       
    53 
       
    54 /** 
       
    55 *  @function ResetContainer
       
    56 *  @since S60 3.2
       
    57 *  Reset the Flag, which helps to create a new Container 
       
    58 */
       
    59 	   	void ResetContainer();
       
    60 
       
    61 /** 
       
    62 *  @function SetMiddleSoftKey
       
    63 *  @since S60 3.2
       
    64 *  This will set the Label for MSK
       
    65 */
       
    66     	void SetMiddleSoftKey(TBool aValue);
       
    67     	
       
    68     public:// Functions from base classes
       
    69 /**
       
    70 * From CAknView, return view id of this view
       
    71 *
       
    72 * @function Id
       
    73 * @since 3.2
       
    74 * @return view id
       
    75 */    
       
    76        	TUid Id() const;
       
    77 
       
    78 /** 
       
    79  * @function HandleCommandL
       
    80  * @since S60 3.2  
       
    81  * takes care of command handling.
       
    82  * @param aCommand command to be handled
       
    83  */
       
    84        	void HandleCommandL(TInt aCommand);	
       
    85        	
       
    86 /** 
       
    87  * @function ResourceChangeHdl
       
    88  * @since S60 3.2  
       
    89  * Handler for resource change
       
    90  * @param aType - Type of resource change event
       
    91  */
       
    92      void ResourceChangeHdl(TInt aType);        	
       
    93 
       
    94     	
       
    95     protected: // Functions from base classes
       
    96 /**
       
    97 * From CAknView
       
    98 * @function DoActivateL 
       
    99 * activation handler
       
   100 *
       
   101 * @since 3.2
       
   102 * @param aPrevViewId ID of previious view.
       
   103 */    
       
   104        	void DoActivateL(const TVwsViewId& aPrevViewId,TUid,const TDesC8& );
       
   105 
       
   106 /**
       
   107 * From CAknView
       
   108 * @function DoDeactivate 
       
   109 * de-activation handler
       
   110 *
       
   111 * @since 3.2
       
   112 * @param aPrevViewId ID of previious view.
       
   113 */    
       
   114        	void DoDeactivate();
       
   115 /**
       
   116 * From MEikMenuObserver
       
   117 * @function DynInitMenuPaneL 
       
   118 * used to manage the menu when
       
   119 * no item are in the list box.
       
   120 * We need to delete the "Open"
       
   121 * menu item in this case.
       
   122 *
       
   123 * @since 3.2
       
   124 * @param aResource resource ID of menu pane
       
   125 * @param aMenuPane instance of menupane
       
   126 */   
       
   127     	void DynInitMenuPaneL(TInt aResourceId, CEikMenuPane* aMenuPane);
       
   128     
       
   129     private:
       
   130 /** 
       
   131 *  @function CCSXHGenericView
       
   132 *  @since S60 3.2
       
   133 *  Perform the first phase of two phase construction
       
   134 */    
       
   135        	CCSXHGenericView(const TUid&,const TInt&);
       
   136 
       
   137 /** 
       
   138 *  @function ConstructL
       
   139 *  @since S60 3.2
       
   140 *  Perform the second phase construction of a genericview object
       
   141 */	 	
       
   142        	void ConstructL(); 
       
   143     
       
   144     private:
       
   145         CCSXHGenericContainer *iContainer;
       
   146         TBool iResetContainerInActivate;
       
   147         
       
   148         TUid  iUid;
       
   149         const TInt &iAppFlags;
       
   150 
       
   151     };
       
   152 
       
   153 #endif /* INC_CSXHGENERICVIEW_H_HEADER_INCLUDED_BC03B1F7 */