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 Provider Base class is the class that has to be contained as a member |
|
17 * in all Plug-in Interfaces. |
|
18 * |
|
19 */ |
|
20 |
|
21 #ifndef SMFPROVIDERBASE_H_ |
|
22 #define SMFPROVIDERBASE_H_ |
|
23 |
|
24 #include <QImage> |
|
25 #include <QUrl> |
|
26 #include <QBuffer> |
|
27 #include <smfglobal.h> |
|
28 #include <qdatastream.h> |
|
29 #include <QSharedData> |
|
30 |
|
31 /** |
|
32 * @ingroup smf_plugin_group |
|
33 * The Provider Base class is the class that has to be contained as a member |
|
34 * in all Plug-in Interfaces. |
|
35 * |
|
36 * All of plug-ins should contain this class as a member and should also |
|
37 * contain a public method to get instance of this class. |
|
38 */ |
|
39 class SmfProviderBase |
|
40 { |
|
41 public: |
|
42 /** |
|
43 * Destructor |
|
44 */ |
|
45 virtual ~SmfProviderBase( ) {} |
|
46 |
|
47 /** |
|
48 * Method to get the Localisable name of the service. |
|
49 * @return The Localisable name of the service. |
|
50 */ |
|
51 virtual QString serviceName( ) const = 0; |
|
52 |
|
53 /** |
|
54 * Method to get the Logo of the service |
|
55 * @return The Logo of the service |
|
56 */ |
|
57 virtual QImage serviceIcon( ) const = 0; |
|
58 |
|
59 /** |
|
60 * Method to get the Readable service description |
|
61 * @return The Readable service description |
|
62 */ |
|
63 virtual QString description( ) const = 0; |
|
64 |
|
65 /** |
|
66 * Method to get the Website of the service |
|
67 * @return The Website of the service |
|
68 */ |
|
69 virtual QUrl serviceUrl( ) const = 0; |
|
70 |
|
71 /** |
|
72 * Method to get the URL of the Application providing this service |
|
73 * @return The URL of the Application providing this service |
|
74 */ |
|
75 virtual QUrl applicationUrl( ) const = 0; |
|
76 |
|
77 /** |
|
78 * Method to get the Icon of the application |
|
79 * @return The Icon of the application |
|
80 */ |
|
81 virtual QImage applicationIcon( ) const = 0; |
|
82 |
|
83 /** |
|
84 * Method to get the Plugin specific ID |
|
85 * @return The Plugin specific ID |
|
86 */ |
|
87 virtual QString pluginId( ) const = 0; |
|
88 |
|
89 /** |
|
90 * Method to get the ID of the authentication application |
|
91 * for this service |
|
92 * @param aProgram The authentication application name |
|
93 * @param aArguments List of arguments required for authentication app |
|
94 * @param aMode Strting mode for authentication application |
|
95 * @return The ID of the authentication application |
|
96 */ |
|
97 virtual QString authenticationApp( QString &aProgram, QStringList & aArguments, |
|
98 QIODevice::OpenModeFlag aMode = QIODevice::ReadWrite ) const = 0; |
|
99 |
|
100 /** |
|
101 * Method to get the unique registration ID provided by the |
|
102 * Smf for authorised plugins |
|
103 * @return The unique registration ID/token provided by the Smf for |
|
104 * authorised plugins |
|
105 */ |
|
106 virtual QString smfRegistrationId( ) const = 0; |
|
107 }; |
|
108 |
|
109 Q_DECLARE_INTERFACE( SmfProviderBase, "org.symbian.smf.plugin.smfproviderbase/v1.0" ); |
|
110 |
|
111 #endif /* SMFPROVIDERBASE_H_ */ |
|