Nokia N97 SDK
Example Applications Guide

CViewTemplate< T > Class Template Reference

#include <ViewTemplate.h>

Inheritance diagram for CViewTemplate< T >:

List of all members.

Detailed Description

template<class T>
class CViewTemplate< T >

CViewTemplate is a template class for creating a view for Avkon View-switching architecture. CViewTemplate is used as view classes for CListboxNumberContainer and CListboxGraphicContainer containers.

CViewTemplate sets context specific options menu for view's MSK by giving the menubar resource id to CViewTemplate::NewL(). Setting is done with CEikMenuBar::SetContextMenuTitleResourceId() function call, which is required for the MSK functionality. If menu is not given, MSK does not have menu.

This template class requires that container class implements following functions :

Parameters:
T  container class used by this view

Definition at line 47 of file ViewTemplate.h.


Public Member Functions

virtual  ~CViewTemplate ()
TUid  Id () const
void  HandleCommandL (TInt aCommand)
void  DoActivateL (const TVwsViewId &aPrevViewId, TUid aCustomMessageId, const TDesC8 &aCustomMessage)
void  DoDeactivate ()
void  DynInitMenuPaneL (TInt aResourceId, CEikMenuPane *aMenuPane)
void  HandleSizeChange (TInt aType)
void  MenuItemToDimm (TInt aMenuItemId)

Static Public Member Functions

static CViewTemplate *  NewL (TInt aViewResource, TInt aMenubarResource, TUid aViewId)
static CViewTemplate *  NewLC (TInt aViewResource, TInt aMenubarResource, TUid aViewId)

Private Member Functions

void  ConstructL (TInt aViewResource)
  CViewTemplate (TUid aViewId, TInt aMenubarResource)

Private Attributes

T *  iContainer
TUid  iIdentifier
TInt  iMenubarResource
TInt  iItemToDimm


Constructor & Destructor Documentation

template<class T>
CViewTemplate< T >::~CViewTemplate (   )  [virtual]
 

Virtual Destructor.

Definition at line 189 of file ViewTemplate.h.

References CViewTemplate< T >::iContainer.

00190     {
00191     if( iContainer ) 
00192         delete iContainer;
00193     }

template<class T>
CViewTemplate< T >::CViewTemplate (  TUid  aViewId,
TInt  aMenubarResource
)  [private]
 

C++ default constructor.

Parameters:
aViewId  Unique id of the view
aMenubarResource  Resource id of the view menubar

Definition at line 177 of file ViewTemplate.h.

00178                                                                             : 
00179     iIdentifier( aViewId ),
00180     iMenubarResource( aMenubarResource ),
00181     iItemToDimm( 0 )
00182     {        
00183     }


Member Function Documentation

template<class T>
CViewTemplate< T > * CViewTemplate< T >::NewL (  TInt  aViewResource,
TInt  aMenubarResource,
TUid  aViewId
)  [static]
 

Two-phased constructor.

Parameters:
aViewResource  Resource id of the view
aMenubarResource  Resource id of the view menubar
aViewId  Unique id of the view
Returns:
a pointer to the created instance of CViewTemplate.

Definition at line 200 of file ViewTemplate.h.

References CViewTemplate< T >::NewLC().

Referenced by CListboxAppUi::ConstructL().

00202     {
00203     CViewTemplate<T>* self = CViewTemplate<T>::NewLC( aViewResource, 
00204             aMenubarResource, aViewId );
00205     CleanupStack::Pop( self );
00206     return self;    
00207     }

template<class T>
CViewTemplate< T > * CViewTemplate< T >::NewLC (  TInt  aViewResource,
TInt  aMenubarResource,
TUid  aViewId
)  [static]
 

Two-phased constructor.

Parameters:
aViewResource  Resource id of the view
aMenubarResource  Resource id of the view menubar
aViewId  Unique id of the view
Returns:
A pointer to the created instance of CViewTemplate.

Definition at line 214 of file ViewTemplate.h.

Referenced by CViewTemplate< T >::NewL().

00216     {
00217     CViewTemplate<T>* self = new ( ELeave ) CViewTemplate<T>( aViewId, 
00218                                                               aMenubarResource );
00219     CleanupStack::PushL( self );
00220     self->ConstructL( aViewResource );
00221     return self;    
00222     }

template<class T>
TUid CViewTemplate< T >::Id (   )  const
 

Returns:
Id Uid value

Definition at line 239 of file ViewTemplate.h.

References CViewTemplate< T >::iIdentifier.

00240     {
00241     return iIdentifier;
00242     }

template<class T>
void CViewTemplate< T >::HandleCommandL (  TInt  aCommand  ) 
 

HandleCommandL From CAknView, takes care of command handling.

Parameters:
aCommand  Command to be handled

Definition at line 291 of file ViewTemplate.h.

References CViewTemplate< T >::iContainer.

00292    {
00293     switch( aCommand )
00294         {
00295         case EListboxCommandAddItem:        
00296             iContainer->AddItemL();            
00297             break;
00298         case EListboxCommandRemoveItem:
00299                 iContainer->RemoveItemL();
00300             break;      
00301         default:    
00302             AppUi()->HandleCommandL( aCommand );
00303         }
00304     }

template<class T>
void CViewTemplate< T >::DoActivateL (  const TVwsViewId &  aPrevViewId,
TUid  aCustomMessageId,
const TDesC8 &  aCustomMessage
) 
 

From CAknExView, activate an AknView.

Parameters:
aPrevViewId  The id of the previous view
aCustomMessageId  message identifier
aCustomMessage  custom message provided when the view is changed

Definition at line 249 of file ViewTemplate.h.

References CViewTemplate< T >::iContainer, and CViewTemplate< T >::iMenubarResource.

00253     {
00254     iContainer = new ( ELeave ) T();
00255     iContainer->SetMopParent( this );
00256     iContainer->ConstructL( ClientRect() );
00257     
00258     
00259     if( iMenubarResource > 0 )
00260         {
00261         CEikMenuBar* menuBar = MenuBar();
00262         menuBar->SetContextMenuTitleResourceId( iMenubarResource ); 
00263         }
00264         
00265     AppUi()->AddToStackL( *this, iContainer );
00266          
00267     iContainer->MakeVisible( ETrue );
00268     }

template<class T>
void CViewTemplate< T >::DoDeactivate (   ) 
 

From AknView, deactivate an AknView Remove the container class instance from the App UI's stack and deletes the instance

Definition at line 275 of file ViewTemplate.h.

References CViewTemplate< T >::iContainer.

00276     {
00277     if ( iContainer )
00278         {
00279         // Remove container form controllStack
00280         AppUi()->RemoveFromStack( iContainer );
00281         delete iContainer;
00282         iContainer = NULL;
00283         }
00284     }

template<class T>
void CViewTemplate< T >::DynInitMenuPaneL (  TInt  aResourceId,
CEikMenuPane *  aMenuPane
) 
 

From MEikMenuObserver, DynInitMenuPaneL. This function is called by the EIKON framework just before it displays a menu pane.

Parameters:
aResourceId  The ID of command which defined in resource file.
aMenuPane  Pointer to menu-pane object.

Definition at line 344 of file ViewTemplate.h.

References CViewTemplate< T >::iItemToDimm.

00346     {            
00347     // Hide user selected menu item
00348     TInt index;
00349     if( aMenuPane->MenuItemExists (iItemToDimm, index) )
00350         {
00351         aMenuPane->SetItemDimmed( iItemToDimm, ETrue );    
00352         }
00353         
00354     // From options menu and MSK menu we remove always "Remove item" item
00355     // if there is no items to remove
00356     if( aMenuPane->MenuItemExists (EListboxCommandRemoveItem, index) )
00357         {
00358         // Hide "Remove item" menu item if listbox does not contain any items
00359         if( iContainer->ItemCount() < 1 )
00360             aMenuPane->SetItemDimmed( EListboxCommandRemoveItem, ETrue );   
00361         }
00362     }                

template<class T>
void CViewTemplate< T >::HandleSizeChange (  TInt  aType  ) 
 

Called by HandleResourceChangeL() from CListboxAppUi when layout is changed.

Parameters:
aType  Type of resources that have changed

Definition at line 312 of file ViewTemplate.h.

References CViewTemplate< T >::iContainer.

Referenced by CListboxAppUi::HandleResourceChangeL().

00313     {
00314     if( iContainer )
00315         {
00316         iContainer->HandleResourceChange( aType );
00317         
00318         if( aType==KEikDynamicLayoutVariantSwitch )
00319             {        
00320             TRect rect;
00321             AknLayoutUtils::LayoutMetricsRect(AknLayoutUtils::EMainPane, rect);
00322             iContainer->SetRect(rect);
00323             }
00324         }         
00325     }

template<class T>
void CViewTemplate< T >::MenuItemToDimm (  TInt  aMenuItemId  ) 
 

With this function is possible to dimm selected menuitem from options menu or from its submenus.

Parameters:
aMenuItemId  Menu item id

Definition at line 333 of file ViewTemplate.h.

References CViewTemplate< T >::iItemToDimm.

Referenced by CListboxAppUi::ConstructL().

00334     {
00335     iItemToDimm = aMenuItemId;    
00336     } 

template<class T>
void CViewTemplate< T >::ConstructL (  TInt  aViewResource  )  [private]
 

2nd phase constructor.

Definition at line 229 of file ViewTemplate.h.

00230     {
00231     BaseConstructL( aViewResource );        
00232     }


Member Data Documentation

template<class T>
T* CViewTemplate< T >::iContainer [private]
 

Container for this view.

Owned.

Definition at line 154 of file ViewTemplate.h.

Referenced by CViewTemplate< T >::DoActivateL(), CViewTemplate< T >::DoDeactivate(), CViewTemplate< T >::HandleCommandL(), CViewTemplate< T >::HandleSizeChange(), and CViewTemplate< T >::~CViewTemplate().

template<class T>
TUid CViewTemplate< T >::iIdentifier [private]
 

View Identifier

Definition at line 159 of file ViewTemplate.h.

Referenced by CViewTemplate< T >::Id().

template<class T>
TInt CViewTemplate< T >::iMenubarResource [private]
 

MSK menubar resource ID

Definition at line 164 of file ViewTemplate.h.

Referenced by CViewTemplate< T >::DoActivateL().

template<class T>
TInt CViewTemplate< T >::iItemToDimm [private]
 

Identifier for dimmed menu item

Definition at line 169 of file ViewTemplate.h.

Referenced by CViewTemplate< T >::DynInitMenuPaneL(), and CViewTemplate< T >::MenuItemToDimm().


The documentation for this class was generated from the following file:

© Nokia 2009

Back to top