|
1 /* |
|
2 * Copyright (c) 2010 Ixonos Plc. |
|
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 * Nokia Corporation - Initial contribution |
|
11 * |
|
12 * Contributors: |
|
13 * Ixonos Plc |
|
14 * |
|
15 * Description: |
|
16 * |
|
17 */ |
|
18 |
|
19 |
|
20 |
|
21 #ifndef PLUGINBASE_H |
|
22 #define PLUGINBASE_H |
|
23 |
|
24 #include <e32base.h> |
|
25 #include <eikimage.h> |
|
26 |
|
27 |
|
28 /* CLASS: CPluginBase |
|
29 * |
|
30 * |
|
31 */ |
|
32 class CPluginBase : public CBase |
|
33 { |
|
34 |
|
35 public: |
|
36 |
|
37 |
|
38 /** @name Methods:*/ |
|
39 //@{ |
|
40 |
|
41 /** NewL factory method, pops cleanupstack |
|
42 * |
|
43 * @param - |
|
44 * @return CPluginBase *, pointer to created CPluginBase object |
|
45 */ |
|
46 IMPORT_C static CPluginBase * NewL (); |
|
47 |
|
48 /** Default constructor |
|
49 * |
|
50 * @param - |
|
51 * @return - |
|
52 */ |
|
53 IMPORT_C CPluginBase (); |
|
54 |
|
55 /** Second phase constructor, may leave |
|
56 * |
|
57 * @param - |
|
58 * @return - |
|
59 */ |
|
60 IMPORT_C void ConstructL (); |
|
61 |
|
62 /* Destructor |
|
63 * |
|
64 * @param - |
|
65 * @return - |
|
66 */ |
|
67 IMPORT_C virtual ~CPluginBase (); |
|
68 |
|
69 /* SetProperty |
|
70 * |
|
71 * Sets plug-in property. |
|
72 * |
|
73 * @param aPropertyId - ID number of the property |
|
74 * @param aPropertyValue - new property value as descriptor |
|
75 * @return TInt - KErrNone if everything ok, one of the system wide |
|
76 * error codes otherwise |
|
77 */ |
|
78 IMPORT_C virtual TInt SetProperty ( |
|
79 TInt aPropertyId, |
|
80 TDesC & aPropertyValue |
|
81 ); |
|
82 |
|
83 /* GetProperty |
|
84 * |
|
85 * Gets plug-in property. |
|
86 * |
|
87 * @param aPropertyId - ID number of the queried property |
|
88 * @param aPropertyValue - queried property value as descriptor |
|
89 * @return TInt - KErrNone if everything ok, one of the system wide |
|
90 * error codes otherwise |
|
91 */ |
|
92 IMPORT_C virtual TInt GetProperty ( |
|
93 TInt aPropertyId, |
|
94 TDes & aPropertyValue |
|
95 ); |
|
96 |
|
97 /* ReservedBaseMethod1 |
|
98 * |
|
99 * Reserved method to export table for future extensions. |
|
100 * |
|
101 * @param - |
|
102 * @return - |
|
103 */ |
|
104 IMPORT_C virtual void ReservedBaseMethod1 (); |
|
105 |
|
106 /* ReservedBaseMethod2 |
|
107 * |
|
108 * Reserved method to export table for future extensions. |
|
109 * |
|
110 * @param - |
|
111 * @return - |
|
112 */ |
|
113 IMPORT_C virtual void ReservedBaseMethod2 (); |
|
114 |
|
115 //@} |
|
116 |
|
117 protected: |
|
118 |
|
119 /** @name Methods:*/ |
|
120 //@{ |
|
121 |
|
122 //@} |
|
123 |
|
124 /** @name Members:*/ |
|
125 //@{ |
|
126 |
|
127 //@} |
|
128 |
|
129 private: |
|
130 |
|
131 /** @name Methods:*/ |
|
132 //@{ |
|
133 |
|
134 //@} |
|
135 |
|
136 /** @name Members:*/ |
|
137 //@{ |
|
138 |
|
139 /* |
|
140 * Internal representation pointer. |
|
141 * |
|
142 * DO NOT add any other private members here, so that the size |
|
143 * of the class stays constant. |
|
144 */ |
|
145 void * iPluginBaseInternalRepresentation; |
|
146 |
|
147 //@} |
|
148 |
|
149 }; |
|
150 |
|
151 |
|
152 #endif |
|
153 |
|
154 // End of File |