1 /*

     2 * Copyright (c) 2009 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:  Interface definition for Location integration plug-in

    15 *

    16 */

    17 

    18 

    19 #ifndef MESMRLOCATIONPLUGIN_H

    20 #define MESMRLOCATIONPLUGIN_H

    21 

    22 

    23 #include <e32def.h>

    24 

    25 class CCalGeoValue;

    26 

    27 /**

    28  *  MESMRLocationPlugin defines the interface for accessing location service provider

    29  *  from ESMR GUI.

    30  */

    31 

    32 class MESMRLocationPlugin

    33     {

    34 

    35 public:

    36 

    37     /**

    38      * Shows map on the screen and asks user to select a position.

    39      * The function returns immediately and the selection is provided

    40      * to the caller via MESMRLocationPluginObserver interface.

    41      *

    42      * @param aSearchQuery Text to show as default address

    43      * @param aLocationUrl URL containing coordinates for maps focus

    44      */

    45     virtual void SelectFromMapL(

    46             const TDesC& aSearchQuery,

    47             const TDesC& aLocationUrl ) = 0;

    48 

    49     /**

    50      * Shows map on the screen and asks user to select a position.

    51      * The function returns immediately and the selection is provided

    52      * to the caller via MESMRLocationPluginObserver interface.

    53      *

    54      * @param aSearchQuery Text to show as default address

    55      * @param aGeoValue coordinates for maps focus

    56      */

    57     virtual void SelectFromMapL(

    58             const TDesC& aSearchQuery,

    59             const CCalGeoValue* aGeoValue ) = 0;

    60 

    61     /**

    62      * Shows map on the screen. User may edit the search string and search

    63      * the position from the map, but the selection is not provided to the

    64      * caller

    65      *

    66      * @param aSearchQuery Text to show as default address

    67      */

    68     virtual void SearchFromMapL( const TDesC& aSearchQuery ) = 0;

    69 

    70     /**

    71      * Shows map on the screen focused on the given location.

    72      *

    73      * @param aLocationUrl URL containing coordinates for maps focus

    74      */

    75     virtual void ShowOnMapL( const TDesC& aLocationUrl ) = 0;

    76 

    77     /**

    78      * Shows map on the screen focused on the given location.

    79      *

    80      * @param aGeoValue the coordinates for maps focus

    81      */

    82     virtual void ShowOnMapL( const CCalGeoValue& aGeoValue ) = 0;

    83 

    84 protected:

    85 

    86     virtual ~MESMRLocationPlugin() {}

    87 

    88     };

    89 

    90 #endif // MESMRLOCATIONPLUGIN_H

    91