1 /*

     2 * Copyright (c) 2008-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 URL Parser plug-in

    15 *

    16 */

    17 

    18 

    19 #ifndef MESMRURLPARSERPLUGIN_H

    20 #define MESMRURLPARSERPLUGIN_H

    21 

    22 

    23 

    24 class CPosLandmark;

    25 class CCalGeoValue;

    26 

    27 /**

    28  *  MESMRUrlParserPlugin defines the interface for Location URL Parser

    29  *

    30  */

    31 class MESMRUrlParserPlugin

    32     {

    33 

    34 public:

    35     /**

    36      * Finds location URL from given text input

    37      *

    38      * @param aText text where URL is searched from

    39      * @param aUrl points to founded URL after execution

    40      * @return URL start position in aText, if not found returns KErrNotFound

    41      */

    42     virtual TInt FindLocationUrl( const TDesC& aText, TPtrC& aUrl ) = 0;

    43 

    44     /**

    45      * Creates location URL from landmark object

    46      *

    47      * @param aLandmark contains landmark object that is parsed to location URL

    48      * @return pointer to created location URL

    49      */

    50     virtual HBufC* CreateUrlFromLandmarkL( const CPosLandmark& aLandmark ) = 0;

    51 

    52     /**

    53      * Creates landmark object from location URL

    54      *

    55      * @param aUrl contains location URL from which landmark is created

    56      * @return pointer to created landmark object

    57      */

    58     virtual CPosLandmark* CreateLandmarkFromUrlL( const TDesC& aUrl ) = 0;

    59 

    60     /**

    61      * Converts valid location URL to vCal GEO value.

    62      * May leave with KErrNotFound/KErrArgument or other Symbian wide errorcode

    63      *

    64      * @param aUrl location URL to convert

    65      * @return new GEO value

    66      */

    67     virtual CCalGeoValue* CreateGeoValueLC( const TDesC& aUrl ) = 0;

    68 

    69 protected:

    70 

    71    /**

    72     * Destructor.

    73     */

    74     virtual ~MESMRUrlParserPlugin(){}

    75     };

    76 

    77 #endif //   MESMRURLPARSERPLUGIN_H