meetingrequest/mrgui/inc/mesmrlocationplugin.h
branchRCL_3
changeset 12 4ce476e64c59
parent 1 12c456ceeff2
equal deleted inserted replaced
11:0396474f30f5 12:4ce476e64c59
     1 /*
     1 /*
     2 * Copyright (c) 2008-2008 Nokia Corporation and/or its subsidiary(-ies). 
     2 * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
     3 * All rights reserved.
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     4 * This component and the accompanying materials are made available
     5 * under the terms of "Eclipse Public License v1.0"
     5 * under the terms of "Eclipse Public License v1.0"
     6 * which accompanies this distribution, and is available
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
    20 #define MESMRLOCATIONPLUGIN_H
    20 #define MESMRLOCATIONPLUGIN_H
    21 
    21 
    22 
    22 
    23 #include <e32def.h>
    23 #include <e32def.h>
    24 
    24 
       
    25 class CCalGeoValue;
       
    26 
    25 /**
    27 /**
    26  *  MESMRLocationPlugin defines the interface for accessing location service provider
    28  *  MESMRLocationPlugin defines the interface for accessing location service provider
    27  *  from ESMR GUI.
    29  *  from ESMR GUI.
    28  */
    30  */
    29 
    31 
    30 class MESMRLocationPlugin
    32 class MESMRLocationPlugin
    31 	{
    33     {
    32 
    34 
    33 public:
    35 public:
    34 
    36 
    35 	/**
    37     /**
    36      * Shows map on the screen and asks user to select a position.
    38      * Shows map on the screen and asks user to select a position.
    37      * The function returns immediately and the selection is provided
    39      * The function returns immediately and the selection is provided
    38      * to the caller via MESMRLocationPluginObserver interface.
    40      * to the caller via MESMRLocationPluginObserver interface.
    39      *
    41      *
    40      * @param aSearchQuery Text to show as default address
    42      * @param aSearchQuery Text to show as default address
    41      * @param aLocationUrl URL containing coordinates for maps focus
    43      * @param aLocationUrl URL containing coordinates for maps focus
    42      */
    44      */
    43     virtual void SelectFromMapL( const TDesC& aSearchQuery, const TDesC& aLocationUrl ) = 0;
    45     virtual void SelectFromMapL(
    44     
    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 
    45     /**
    61     /**
    46      * Shows map on the screen. User may edit the search string and search
    62      * Shows map on the screen. User may edit the search string and search
    47      * the position from the map, but the selection is not provided to the
    63      * the position from the map, but the selection is not provided to the
    48      * caller
    64      * caller
    49      * 
    65      *
    50      * @param aSearchQuery Text to show as default address
    66      * @param aSearchQuery Text to show as default address
    51      */
    67      */
    52     virtual void SearchFromMapL( const TDesC& aSearchQuery ) = 0;
    68     virtual void SearchFromMapL( const TDesC& aSearchQuery ) = 0;
    53     
    69 
    54     /**
    70     /**
    55      * Shows map on the screen focused on the given location.
    71      * Shows map on the screen focused on the given location.
    56      *
    72      *
    57      * @param aLocation containing name for landmark
       
    58      * @param aLocationUrl URL containing coordinates for maps focus
    73      * @param aLocationUrl URL containing coordinates for maps focus
    59      */
    74      */
    60     virtual void ShowOnMapL( const TDesC& aLocation, const TDesC& aLocationUrl ) = 0;
    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;
    61 
    83 
    62 protected:
    84 protected:
    63 
    85 
    64 	virtual ~MESMRLocationPlugin() {}
    86     virtual ~MESMRLocationPlugin() {}
    65 
    87 
    66     };
    88     };
    67 
    89 
    68 #endif // MESMRLOCATIONPLUGIN_H
    90 #endif // MESMRLOCATIONPLUGIN_H
    69 
    91