smf/inc/smfclient/smfprovider.h
changeset 3 0446eb7b28aa
equal deleted inserted replaced
2:86af6c333601 3:0446eb7b28aa
       
     1 /**
       
     2  * Copyright (c) 2010 Sasken Communication Technologies Ltd.
       
     3  * All rights reserved.
       
     4  * This component and the accompanying materials are made available
       
     5  * under the terms of the "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  * Chandradeep Gandhi, Sasken Communication Technologies Ltd - Initial contribution
       
    11  *
       
    12  * Contributors:
       
    13  * Manasij Roy, Nalina Hariharan
       
    14  * 
       
    15  * Description:
       
    16  * The SmfEvent class represents an event
       
    17  *
       
    18  */
       
    19 
       
    20 #ifndef SMFPROVIDER_H
       
    21 #define SMFPROVIDER_H
       
    22 
       
    23 #include <QObject>
       
    24 #include <QImage>
       
    25 #include <QUrl>
       
    26 
       
    27 #include "../common/SmfClientGlobal.h"
       
    28 /**
       
    29  * @ingroup smf_client_group 
       
    30  * Interface for a base service provider. Other service provider classes contains 
       
    31  * implementation of this base class so that each has access to service provider 
       
    32  * information.
       
    33  * All of the functionality described here should be implemented by a service
       
    34  * specific plug-in object.
       
    35  */
       
    36 class SMFCLIENT_EXPORT SmfProvider : public QObject
       
    37 {
       
    38   Q_OBJECT
       
    39 
       
    40 public:
       
    41   /**
       
    42    *  Seeing as this is a plug-in implementation, these will realistically be generated by SMF factory of some kind
       
    43    */
       
    44    
       
    45   SmfProvider(QObject* parent = 0);
       
    46   ~SmfProvider();
       
    47 
       
    48 public:
       
    49   /**
       
    50    * Localizable name of the service 
       
    51    * @return service name
       
    52    */
       
    53   QString& serviceName() const; 
       
    54   
       
    55   /**
       
    56    * Logo of the service
       
    57    * @return logo image of the service
       
    58    */
       
    59   QImage& serviceIcon() const; 
       
    60   
       
    61   /**
       
    62    * Readable service description
       
    63    * @return service description
       
    64    */
       
    65   QString description() const; 
       
    66   
       
    67   /*
       
    68    * Website of the service
       
    69    */
       
    70   QUrl serviceUrl() const;
       
    71   
       
    72   /**
       
    73    * URL of the application providing this service
       
    74    */
       
    75   QUrl applicationUrl() const; //
       
    76   
       
    77   /**
       
    78    * service types - list of interfaces that this provider support
       
    79    */
       
    80   QList<QString> serviceTypes() const;
       
    81 };
       
    82 /**
       
    83 * Externalization
       
    84 */
       
    85 QDataStream &operator<<(QDataStream &, const SmfProvider&);
       
    86 /**
       
    87  * Internalization
       
    88  */
       
    89 QDataStream &operator>>(QDataStream &, SmfProvider&);
       
    90 
       
    91 #endif // SMFPROVIDER_H