1 /*

     2 * Copyright (c) 2005-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:  CMnNavigationServiceBase class

    15 *

    16 */

    17 

    18 

    19 #ifndef MN_NAVIGATIONSERVICEBASE_H

    20 #define MN_NAVIGATIONSERVICEBASE_H

    21 

    22 #include "mnservicebase.h"

    23 

    24 class CPosLandmark;

    25 

    26 /** @brief Base class for navigation service implementations (KMnAppNavigationService). 

    27  * 

    28  *  Provider Application must derive its navigation service 

    29  *  class from this one. This base implementation

    30  *  hides IPC communication details.

    31  *

    32  *  Provider Application must return pointer to instance of its class, derived

    33  *  from this class, in response to CAknAppService::CreateServiceL() call,

    34  *  if given parameter is KMnAppNavigationService. 

    35  *

    36  *  This class defines navigation request handler as pure 

    37  *  virtual method, which derived class must implement. 

    38  *  Implementation must obey specification of @ref CMnNavigator.

    39  *

    40  *  See parent @ref CMnServiceBase class documentation for 

    41  *  other details.

    42  *

    43  *  @since 3.1

    44  *  @lib mnservicelib.lib

    45  *  @ingroup MnProviderAPI

    46  */

    47 class CMnNavigationServiceBase : public CMnServiceBase

    48     {

    49     public :

    50     protected :

    51         /** C++ constructor */

    52         IMPORT_C CMnNavigationServiceBase();

    53         /** Destructor */

    54         IMPORT_C ~CMnNavigationServiceBase();

    55 

    56         /** This method must be called from derived class' ConstructL to

    57          *  allow internal initialization of this class. */

    58         IMPORT_C void BaseConstructL();

    59 

    60         /** @brief Handles client's request for navigation. 

    61          *

    62          *  Derived class must implement this method obeying specification of 

    63          *  @ref CMnNavigator::NavigateToL() and if KMnSvcFeatureNavigateTo

    64          *  feature is specified in SERVICE_INFO.

    65          *

    66          *  This is synchronous request.

    67          *  Client's request will be completed when this method exits, therefore

    68          *  it should exit immediately after navigation is started.

    69          *

    70          *  @param[in] aDestination The landmark, defines destination of the

    71          *                      navigation requested.

    72          *  

    73          *  @leave KErrNotSupported Should leave if this feature is not supported.

    74          */

    75         virtual void HandleNavigateToL(const CPosLandmark& aDestination) =0;

    76 

    77     protected: // From CAknAppServiceBase

    78 

    79         /** \internal */

    80         IMPORT_C virtual void ServiceL(const RMessage2& aMessage);

    81     };

    82 

    83 #endif // MN_NAVIGATIONSERVICEBASE_H

    84