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:  CMnProvider class

    15 *

    16 */

    17 

    18 

    19 #ifndef MN_PROVIDER_H

    20 #define MN_PROVIDER_H

    21 

    22 #include <e32base.h>

    23 

    24 /** Represents information about Provider Application.

    25  *  

    26  *  Use class @ref MnProviderFinder to find all provider applications.

    27  *

    28  *  @since 3.1

    29  *  @lib mnclientlib.dll

    30  *  @ingroup MnProviderDiscoveryAPI

    31  */   

    32 class CMnProvider : public CBase

    33     {

    34     public :

    35         /** Type for bitmap of @ref TService values. */

    36         typedef TUint32 TServices;

    37         

    38         /** Map and Navigation application services */

    39         enum TService

    40             {

    41             /** Uninitialized value */

    42             EServiceNone            = 0x00,

    43             /** Defines that Provider Application supports

    44              *  CMnMapView */

    45             EServiceMapView         = 0x01,

    46             /** Defines that Provider Application supports

    47              *  CMnNavigator */

    48             EServiceNavigation      = 0x02,

    49             /** Defines that Provider Application supports

    50              *  CMnGeocoder */

    51             EServiceGeocoding       = 0x04,

    52             /** Defines that Provider Application supports 

    53              *  requests for map images */

    54             EServiceMapImage        = 0x08

    55             };

    56     

    57         /** Destructor */

    58         IMPORT_C ~CMnProvider();

    59     

    60         /** Returns UID of Provider Application */

    61         IMPORT_C TUid Uid() const;

    62         

    63         /** Returns version information of Provider Application */

    64         IMPORT_C TVersion Version() const;

    65         

    66         /** Returns localized name of this Provider Application.

    67          *

    68          *  Displayable name is specified in application registration file.

    69          *  (See APP_REGISTRATION_INFO for details).

    70          *  @param[out] aName Displayable name of Provider Application

    71          */

    72         IMPORT_C void GetName( TPtrC& aName ) const;

    73         

    74         /** Returns short localized name of this Provider Application.

    75          *

    76          *  Short name is specified in its application registration file.

    77          *  (See APP_REGISTRATION_INFO for details).

    78          *  @param[out] aShortName Short displayable name of Provider Application

    79          */

    80         IMPORT_C void GetShortName( TPtrC& aShortName ) const;

    81         

    82         /** Returns localized name of Provider Application's vendor. 

    83          *

    84          *  @param[out] aVendorName Vendor name of this Provider Application

    85          */

    86         IMPORT_C void GetVendorName( TPtrC& aVendorName ) const;

    87         

    88         /** Returns what map and navigation related services 

    89          *  are supported by this Provider Application. */

    90         IMPORT_C TServices SupportedServices() const;

    91 

    92         /* Returns what service features

    93          *  are supported by this Provider Application. 

    94          *  Service features are defined in MnAppServices.hrh.

    95          */

    96         virtual TUint32 SupportedFeatures( TService aService ) const;

    97 

    98     protected :

    99         CMnProvider();

   100         CMnProvider( CMnProvider& );

   101 

   102     protected :

   103         TUid iUid;

   104         HBufC* iName;

   105         HBufC* iShortName;

   106         HBufC* iVendorName;

   107         TServices iServices;

   108         TVersion iVersion;

   109     };

   110 

   111 #endif // MN_PROVIDER_H