uiservicetab/vimpststorage/tsrc/vimpststorage_ut/src/pbkuistubs.cpp
branchRCL_3
changeset 23 9a48e301e94b
parent 0 5e5d6b214f4f
equal deleted inserted replaced
22:3104fc151679 23:9a48e301e94b
       
     1 /*
       
     2 * Copyright (c) 2005-2007 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:  
       
    15 :                
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 
       
    21 
       
    22 
       
    23 // INCLUDES
       
    24 #include "pbkuistubs.h"
       
    25 
       
    26 
       
    27 /**
       
    28  * Returns Phonebook 2 application UI interface.
       
    29  * Usage: MPbk2AppUi* appUi = Phonebook2::Pbk2AppUi();
       
    30  *
       
    31  * @return  Phonebook 2 application UI interface.
       
    32  */
       
    33 EXPORT_C MPbk2AppUi* Phonebook2::Pbk2AppUi()
       
    34 {
       
    35 return NULL;	
       
    36 };
       
    37 
       
    38 CPbk2AppUiStub::CPbk2AppUiStub(){ }
       
    39 
       
    40 CPbk2AppUiStub::~CPbk2AppUiStub(){ }
       
    41 
       
    42 /**
       
    43  * Returns the currently active view.
       
    44  *
       
    45  * @return  Active view.
       
    46  */
       
    47 CPbk2AppViewBase* CPbk2AppUiStub::ActiveView() const { return NULL; }
       
    48 
       
    49 /**
       
    50  * Returns the Phonebook 2 view explorer if it exists.
       
    51  *
       
    52  * @return  View explorer.
       
    53  */
       
    54 MPbk2ViewExplorer* CPbk2AppUiStub::Pbk2ViewExplorer() const { return NULL; }
       
    55 
       
    56 /**
       
    57  * Returns the Phonebook 2 startup monitor.
       
    58  *
       
    59  * @return  Startup monitor.
       
    60  */
       
    61 MPbk2StartupMonitor* CPbk2AppUiStub::Pbk2StartupMonitor() const { return NULL; }
       
    62 
       
    63 /**
       
    64  * Returns Phonebook 2 tab group container.
       
    65  *
       
    66  * @return  Tab group container.
       
    67  */
       
    68 CPbk2TabGroupContainer* CPbk2AppUiStub::TabGroups() const { return NULL; }
       
    69 
       
    70 /**
       
    71  * Returns Phonebook 2 key event handler.
       
    72  *
       
    73  * @return  Key event handler.
       
    74  */
       
    75 MPbk2KeyEventHandler& CPbk2AppUiStub::KeyEventHandler() 
       
    76 { 
       
    77 MPbk2KeyEventHandler* ret = NULL;
       
    78 return *ret;
       
    79 }
       
    80 
       
    81 /**
       
    82  * Returns Phonebook 2 application services.
       
    83  *
       
    84  * @return  Application services.
       
    85  */
       
    86 MPbk2ApplicationServices& CPbk2AppUiStub::ApplicationServices() const 
       
    87 { 
       
    88 MPbk2ApplicationServices* ret = NULL;
       
    89 return *ret;
       
    90 }
       
    91 
       
    92 /**
       
    93  * Handles a command. If Phonebook 2 command handler does not
       
    94  * handle a command it can then be passed to application UI
       
    95  * command handler which ultimately handles it.
       
    96  * For example, exit command is handled by
       
    97  * application UI not by command handler.
       
    98  *
       
    99  * @return  Id of the command to handle.
       
   100  */
       
   101 void CPbk2AppUiStub::HandleCommandL(
       
   102         TInt /*aCommand*/ ) { }
       
   103 
       
   104 /**
       
   105  * Exits application.
       
   106  */
       
   107 void CPbk2AppUiStub::ExitApplication() { }
       
   108 
       
   109 CPbk2ApplicationServicesStub::CPbk2ApplicationServicesStub(){ }
       
   110 
       
   111 CPbk2ApplicationServicesStub::~CPbk2ApplicationServicesStub(){ }
       
   112 
       
   113 /**
       
   114  * Returns Virtual Phonebook contact manager.
       
   115  *
       
   116  * @return  Virtual Phonebook contact manager.
       
   117  */
       
   118 CVPbkContactManager& CPbk2ApplicationServicesStub::ContactManager() const 
       
   119 { 
       
   120 CVPbkContactManager* ret = NULL;
       
   121 return *ret;
       
   122 }
       
   123 
       
   124 /**
       
   125  * Returns Phonebook 2 command handler, which handles
       
   126  * all the commands.
       
   127  *
       
   128  * @return  Phonebook 2 command handler.
       
   129  */
       
   130 MPbk2CommandHandler* CPbk2ApplicationServicesStub::CommandHandlerL() 
       
   131 { 
       
   132 return NULL;
       
   133 }
       
   134 
       
   135 /**
       
   136  * Returns the name formatter object.
       
   137  *
       
   138  * @return  Phonebook 2 name formatter.
       
   139  */
       
   140 MPbk2ContactNameFormatter& CPbk2ApplicationServicesStub::NameFormatter() const 
       
   141 { 
       
   142 MPbk2ContactNameFormatter* ret = NULL;
       
   143 return *ret;
       
   144 }
       
   145 
       
   146 /**
       
   147  * Returns the sort order manager.
       
   148  *
       
   149  * @return  Sort order manager.
       
   150  */
       
   151 CPbk2SortOrderManager& CPbk2ApplicationServicesStub::SortOrderManager() const 
       
   152 { 
       
   153 CPbk2SortOrderManager* ret = NULL;
       
   154 return *ret;
       
   155 }
       
   156 
       
   157 /**
       
   158  * Returns Phonebook 2 global send UI.
       
   159  *
       
   160  * @return  SendUi instance.
       
   161  */
       
   162 CSendUi* CPbk2ApplicationServicesStub::SendUiL() { return NULL; }
       
   163 
       
   164 /**
       
   165  * Returns store property array.
       
   166  *
       
   167  * @return  Store property array.
       
   168  */
       
   169 CPbk2StorePropertyArray& CPbk2ApplicationServicesStub::StoreProperties() const 
       
   170 { 
       
   171 CPbk2StorePropertyArray* ret = NULL;
       
   172 return *ret;
       
   173 }
       
   174 
       
   175 /**
       
   176  * Returns Phonebook 2 field properties.
       
   177  *
       
   178  * @return  Phonebook 2 field properties.
       
   179  */
       
   180 CPbk2FieldPropertyArray& CPbk2ApplicationServicesStub::FieldProperties() const 
       
   181 { 
       
   182 CPbk2FieldPropertyArray* ret = NULL;
       
   183 return *ret;
       
   184 }
       
   185 
       
   186 /**
       
   187  * Returns Phonebook 2 store configuration.
       
   188  *
       
   189  * @return  Phonebook 2 store configuration.
       
   190  */
       
   191 CPbk2StoreConfiguration& CPbk2ApplicationServicesStub::StoreConfiguration() const 
       
   192 { 
       
   193 CPbk2StoreConfiguration* ret=NULL;
       
   194 return *ret;
       
   195 }
       
   196 
       
   197 /**
       
   198  * Returns Phonebook 2 contact store observation register.
       
   199  *
       
   200  * @return  Phonebook 2 store observation register.
       
   201  */
       
   202 MPbk2StoreObservationRegister& CPbk2ApplicationServicesStub::
       
   203     StoreObservationRegister() const 
       
   204     { 
       
   205     MPbk2StoreObservationRegister* ret = NULL;
       
   206     return *ret;
       
   207     }
       
   208     
       
   209 
       
   210 /**
       
   211  * Returns Phonebook 2 contact store validity informer.
       
   212  *
       
   213  * @return  Phonebook 2 store validity informer.
       
   214  */
       
   215 MPbk2StoreValidityInformer& CPbk2ApplicationServicesStub::
       
   216     StoreValidityInformer() const 
       
   217     { 
       
   218     MPbk2StoreValidityInformer* ret = NULL;
       
   219     return *ret;
       
   220     }
       
   221 
       
   222 /**
       
   223  * Returns Phonebook 2 view supplier.
       
   224  *
       
   225  * @return  Phonebook 2 view supplier.
       
   226  */
       
   227 MPbk2ContactViewSupplier& CPbk2ApplicationServicesStub::ViewSupplier() const 
       
   228 { 
       
   229 MPbk2ContactViewSupplier* ret = NULL;
       
   230 return *ret;
       
   231 }
       
   232 
       
   233 /**
       
   234  * Returns global menu filtering flags.
       
   235  *
       
   236  * @return  Global menu filtering flags.
       
   237  */
       
   238 TInt CPbk2ApplicationServicesStub::GlobalMenuFilteringFlagsL() const { return 0; }
       
   239 
       
   240 /**
       
   241  * Returns service manager.
       
   242  *
       
   243  * @return  Service manager.
       
   244  */
       
   245 CPbk2ServiceManager& CPbk2ApplicationServicesStub::ServiceManager() const 
       
   246 { 
       
   247 CPbk2ServiceManager* ret = NULL;
       
   248 return *ret;
       
   249 }
       
   250 
       
   251 CPbk2CommandHandlerStub::CPbk2CommandHandlerStub(){ }
       
   252 
       
   253 CPbk2CommandHandlerStub::~CPbk2CommandHandlerStub(){ }
       
   254 /**
       
   255  * Handles Phonebook 2 commands.
       
   256  *
       
   257  * @param aCommandId    The id of the command to handle.
       
   258  * @param aControl      The UI control of the calling view.
       
   259  * @param aAppView      Application view from where
       
   260  *                      the command is launched.
       
   261  * @return  ETrue if the command was handled, EFalse otherwise.
       
   262  */
       
   263 TBool CPbk2CommandHandlerStub::HandleCommandL(
       
   264         const TInt /*aCommandId*/,
       
   265         MPbk2ContactUiControl& /*aControl*/,
       
   266         const CPbk2AppViewBase* /*aAppView*/ ) { return EFalse; }
       
   267 
       
   268 /**
       
   269  * Performs Phonebook 2 menu filtering.
       
   270  *
       
   271  * @param aResourceId   Resource id of the filtered menu pane.
       
   272  * @param aMenuPane     Menu pane to be filtered.
       
   273  * @param aViewBase     Application view where the filtering
       
   274  *                      takes place.
       
   275  * @param aControl      The UI control of the calling view.
       
   276  */
       
   277 void CPbk2CommandHandlerStub::DynInitMenuPaneL(
       
   278         TInt /*aResourceId*/,
       
   279         CEikMenuPane* /*aMenuPane*/,
       
   280         CPbk2AppViewBase& /*aViewBase*/,
       
   281         MPbk2ContactUiControl& /*aControl*/ ) { }
       
   282 
       
   283 /**
       
   284  * Registers (attaches) to an AIW service.
       
   285  *
       
   286  * @param aInterestId           Id of the AIW interest.
       
   287  * @param aMenuResourceId       Resource id of the menu to
       
   288  *                              attach to the AIW interest.
       
   289  * @param aInterestResourceId   Resource id of the AIW interest.
       
   290  * @param aAttachBaseService    If ETrue, attaches the AIW
       
   291  *                              resource id to the AIW base
       
   292  *                              service also. This enables command
       
   293  *                              handling via AIW without menus.
       
   294  */
       
   295 void CPbk2CommandHandlerStub::RegisterAiwInterestL(
       
   296         const TInt /*aInterestId*/,
       
   297         const TInt /*aMenuResourceId*/,
       
   298         const TInt /*aInterestResourceId*/,
       
   299         const TBool /*aAttachBaseService*/ ) { }
       
   300 
       
   301 /**
       
   302  * Returns the AIW service command id associated to
       
   303  * given menu command. If found, it means that there is a
       
   304  * provider which can handle the menu command.
       
   305  *
       
   306  * @see CAiwServiceHandler::ServiceCmdByMenuCmd
       
   307  * @param aMenuCmdId    Menu command id to inspect.
       
   308  * @return  Service command id or KAiwCmdNone.
       
   309  */
       
   310 TInt CPbk2CommandHandlerStub::ServiceCmdByMenuCmd(
       
   311         TInt /*aMenuCmdId*/ ) const { return 0; }
       
   312 
       
   313 /**
       
   314  * Adds the command into the Phonebook 2 command store and executes it.
       
   315  * Takes the ownership of the command.
       
   316  *
       
   317  * @param aCommand  The command to be executed.
       
   318  */
       
   319 void CPbk2CommandHandlerStub::AddAndExecuteCommandL(
       
   320         MPbk2Command* /*aCommand*/ ) { }
       
   321 
       
   322 /**
       
   323  * Adds a menu command observer.
       
   324  *
       
   325  * @param aObserver     Menu command observer to add.
       
   326  */
       
   327 void CPbk2CommandHandlerStub::AddMenuCommandObserver(
       
   328         MPbk2MenuCommandObserver& /*aObserver*/ ) { }
       
   329 
       
   330 /**
       
   331  * Removes a menu command observer.
       
   332  *
       
   333  * @param aObserver     Menu command observer to remove.
       
   334  */
       
   335 void CPbk2CommandHandlerStub::RemoveMenuCommandObserver(
       
   336         MPbk2MenuCommandObserver& /*aObserver*/ ) { }
       
   337 
       
   338 /**
       
   339  * Initialises toolbar before it is drawn.
       
   340  *
       
   341  * @param aResourceId   The resource id of the toolbar.
       
   342  * @param aToolbar      The toolbar object.
       
   343  * @param aAppView      Application view from where
       
   344  *                      the command is launched.
       
   345  * @param aControl      The UI control of the calling view.
       
   346  */
       
   347 void CPbk2CommandHandlerStub::DynInitToolbarL(
       
   348         TInt /*aResourceId*/,
       
   349         CAknToolbar* /*aToolbar*/,
       
   350         const CPbk2AppViewBase& /*aAppView*/,
       
   351         MPbk2ContactUiControl& /*aControl*/ ) { }
       
   352 
       
   353 /**
       
   354  * Handles toolbar events for a certain toolbar item.
       
   355  *
       
   356  * @param aCommand      The command id of the toolbar item.
       
   357  * @param aControl      The UI control of the calling view.
       
   358  * @param aAppView      Application view from where
       
   359  *                      the command is launched.
       
   360  */
       
   361 void CPbk2CommandHandlerStub::OfferToolbarEventL(
       
   362         TInt /*aCommand*/,
       
   363         MPbk2ContactUiControl& /*aControl*/,
       
   364         const CPbk2AppViewBase* /*aAppView*/ ) { }
       
   365 
       
   366 
       
   367 // End of File