More include optimisations and fixes.
[wine] / include / wine / obj_dataobject.h
1 /*
2  * Defines the COM interfaces and APIs related to IDataObject.
3  *
4  * Depends on 'obj_moniker.h', 'obj_storage.h' and 'obj_base.h'.
5  */
6
7 #ifndef __WINE_WINE_OBJ_DATAOBJECT_H
8 #define __WINE_WINE_OBJ_DATAOBJECT_H
9
10 #include "wine/obj_base.h"
11 #include "wine/obj_storage.h"
12 #include "wine/obj_moniker.h"
13
14 /*****************************************************************************
15  * Predeclare the structures
16  */
17 typedef struct DVTARGETDEVICE16 DVTARGETDEVICE16, *LPDVTARGETDEVICE16;
18 typedef struct DVTARGETDEVICE DVTARGETDEVICE, *LPDVTARGETDEVICE;
19
20 typedef struct FORMATETC16 FORMATETC16, *LPFORMATETC16;
21 typedef struct FORMATETC FORMATETC, *LPFORMATETC;
22
23 typedef struct STGMEDIUM STGMEDIUM, *LPSTGMEDIUM;
24
25
26 /*****************************************************************************
27  * Predeclare the interfaces
28  */
29 DEFINE_OLEGUID(IID_IAdviseSink,         0x0000010fL, 0, 0);
30 typedef struct IAdviseSink IAdviseSink,*LPADVISESINK;
31
32 DEFINE_OLEGUID(IID_IAdviseSink2,        0x00000125L, 0, 0);
33 typedef struct IAdviseSink2 IAdviseSink2,*LPADVISESINK2;
34
35 DEFINE_OLEGUID(IID_IDataAdviseHolder,   0x00000110L, 0, 0);
36 typedef struct IDataAdviseHolder IDataAdviseHolder,*LPDATAADVISEHOLDER;
37
38 DEFINE_OLEGUID(IID_IDataObject,         0x0000010EL, 0, 0);
39 typedef struct IDataObject IDataObject,*LPDATAOBJECT;
40
41 DEFINE_OLEGUID(IID_IEnumFORMATETC,      0x00000103L, 0, 0);
42 typedef struct IEnumFORMATETC IEnumFORMATETC,*LPENUMFORMATETC;
43
44 DEFINE_OLEGUID(IID_IEnumSTATDATA,       0x00000105L, 0, 0);
45 typedef struct IEnumSTATDATA IEnumSTATDATA,*LPENUMSTATDATA;
46
47
48 /*****************************************************************************
49  * DVTARGETDEVICE structure
50  */
51 struct DVTARGETDEVICE
52 {
53     DWORD tdSize;
54     WORD tdDriverNameOffset;
55     WORD tdDeviceNameOffset;
56     WORD tdPortNameOffset;
57     WORD tdExtDevmodeOffset;
58     BYTE tdData[1];
59 };
60
61
62 /*****************************************************************************
63  * FORMATETC structure
64  */
65 /* wished data format */
66 struct FORMATETC
67 {
68     CLIPFORMAT cfFormat;
69     DVTARGETDEVICE* ptd;
70     DWORD dwAspect;
71     LONG lindex;
72     DWORD tymed;
73 };
74
75
76 /*****************************************************************************
77  * STGMEDIUM structure
78  */
79 typedef enum tagTYMED
80 {
81     TYMED_HGLOBAL   = 1,
82         TYMED_FILE      = 2,
83         TYMED_ISTREAM   = 4,
84         TYMED_ISTORAGE  = 8,
85         TYMED_GDI       = 16,
86         TYMED_MFPICT    = 32,
87         TYMED_ENHMF     = 64,
88         TYMED_NULL      = 0
89 } TYMED;
90   
91 /* dataobject as answer to a request */
92 struct STGMEDIUM
93 {
94     DWORD tymed;
95     union {
96         HBITMAP hBitmap;
97         HMETAFILEPICT hMetaFilePict;
98         HENHMETAFILE hEnhMetaFile;
99         HGLOBAL hGlobal;
100         LPOLESTR lpszFileName;
101         IStream *pstm;
102         IStorage *pstg;
103     } u;
104     IUnknown *pUnkForRelease;
105 };   
106
107
108 /*****************************************************************************
109  * IAdviseSink interface
110  */
111 #define ICOM_INTERFACE IAdviseSink
112 #define IAdviseSink_METHODS \
113     ICOM_VMETHOD2(OnDataChange, FORMATETC*,pFormatetc, STGMEDIUM*,pStgmed) \
114     ICOM_VMETHOD2(OnViewChange, DWORD,dwAspect, LONG,lindex) \
115     ICOM_VMETHOD1(OnRename,     IMoniker*,pmk) \
116     ICOM_VMETHOD (OnSave) \
117     ICOM_VMETHOD (OnClose)
118 #define IAdviseSink_IMETHODS \
119     IUnknown_IMETHODS \
120     IAdviseSink_METHODS
121 ICOM_DEFINE(IAdviseSink,IUnknown)
122 #undef ICOM_INTERFACE
123
124 #ifdef ICOM_CINTERFACE
125 /*** IUnknown methods ***/
126 #define IAdviseSink_QueryInterface(p,a,b) ICOM_CALL2(QueryInterface,p,a,b)
127 #define IAdviseSink_AddRef(p)             ICOM_CALL (AddRef,p)
128 #define IAdviseSink_Release(p)            ICOM_CALL (Release,p)
129 /*** IAdviseSink methods ***/
130 #define IAdviseSink_OnDataChange(p,a,b) ICOM_CALL2(OnDataChange,p,a,b)
131 #define IAdviseSink_OnViewChange(p,a,b) ICOM_CALL2(OnViewChange,p,a,b)
132 #define IAdviseSink_OnRename(p,a)       ICOM_CALL1(OnRename,p,a)
133 #define IAdviseSink_OnSave(p)           ICOM_CALL (OnSave,p)
134 #define IAdviseSink_OnClose(p)          ICOM_CALL (OnClose,p)
135 #endif
136
137
138 /*****************************************************************************
139  * IAdviseSink2 interface
140  */
141 #define ICOM_INTERFACE IAdviseSink2
142 #define IAdviseSink2_METHODS \
143     ICOM_VMETHOD1(OnLinkSrcChange, IMoniker*,pmk)
144 #define IAdviseSink2_IMETHODS \
145     IAdviseSink_IMETHODS \
146     IAdviseSink2_METHODS
147 ICOM_DEFINE(IAdviseSink2,IAdviseSink)
148 #undef ICOM_INTERFACE
149
150 #ifdef ICOM_CINTERFACE
151 /*** IUnknown methods ***/
152 #define IAdviseSink2_QueryInterface(p,a,b) ICOM_CALL2(QueryInterface,p,a,b)
153 #define IAdviseSink2_AddRef(p)             ICOM_CALL (AddRef,p)
154 #define IAdviseSink2_Release(p)            ICOM_CALL (Release,p)
155 /*** IAdviseSink methods ***/
156 #define IAdviseSink2_OnDataChange(p,a,b) ICOM_CALL2(IAdviseSink,OnDataChange,p,a,b)
157 #define IAdviseSink2_OnViewChange(p,a,b) ICOM_CALL2(IAdviseSink,OnViewChange,p,a,b)
158 #define IAdviseSink2_OnRename(p,a)       ICOM_CALL1(IAdviseSink,OnRename,p,a)
159 #define IAdviseSink2_OnSave(p)           ICOM_CALL (IAdviseSink,OnSave,p)
160 #define IAdviseSink2_OnClose(p)          ICOM_CALL (IAdviseSink,OnClose,p)
161 /*** IAdviseSink2 methods ***/
162 #define IAdviseSink2_OnLinkSrcChange(p,a) ICOM_CALL(OnLinkSrcChange,p,a)
163 #endif
164
165
166 /*****************************************************************************
167  * IDataAdviseHolder interface
168  */
169 #define ICOM_INTERFACE IDataAdviseHolder
170 #define IDataAdviseHolder_METHODS \
171     ICOM_METHOD5(HRESULT,Advise,           IDataObject*,pDataObject, FORMATETC*,pFetc, DWORD,advf, IAdviseSink*,pAdvise, DWORD*,pdwConnection) \
172     ICOM_METHOD1(HRESULT,Unadvise,         DWORD,dwConnection) \
173     ICOM_METHOD1(HRESULT,EnumAdvise,       IEnumSTATDATA**,ppenumAdvise) \
174     ICOM_METHOD3(HRESULT,SendOnDataChange, IDataObject*,pDataObject, DWORD,dwReserved, DWORD,advf)
175 #define IDataAdviseHolder_IMETHODS \
176     IUnknown_IMETHODS \
177     IDataAdviseHolder_METHODS
178 ICOM_DEFINE(IDataAdviseHolder,IUnknown)
179 #undef ICOM_INTERFACE
180
181 #ifdef ICOM_CINTERFACE
182 /*** IUnknown methods ***/
183 #define IDataAdviseHolder_QueryInterface(p,a,b) ICOM_CALL2(QueryInterface,p,a,b)
184 #define IDataAdviseHolder_AddRef(p)             ICOM_CALL (AddRef,p)
185 #define IDataAdviseHolder_Release(p)            ICOM_CALL (Release,p)
186 /*** IDataAdviseHolder methods ***/
187 #define IDataAdviseHolder_Advise(p,a,b,c,d,e)       ICOM_CALL5(Advise,p,a,b,c,d,e)
188 #define IDataAdviseHolder_Unadvise(p,a)             ICOM_CALL1(Unadvise,p,a)
189 #define IDataAdviseHolder_EnumAdvise(p,a)           ICOM_CALL1(EnumAdvise,p,a)
190 #define IDataAdviseHolder_SendOnDataChange(p,a,b,c) ICOM_CALL3(SendOnDataChange,p,a,b,c)
191 #endif
192
193 /* FIXME: not implemented */
194 HRESULT WINAPI CreateDataAdviseHolder(LPDATAADVISEHOLDER* ppDAHolder);
195
196
197 /*****************************************************************************
198  * IDataObject interface
199  */
200 #define ICOM_INTERFACE IDataObject
201 #define IDataObject_METHODS \
202     ICOM_METHOD2(HRESULT,GetData,               LPFORMATETC,pformatetcIn, STGMEDIUM*,pmedium) \
203     ICOM_METHOD2(HRESULT,GetDataHere,           LPFORMATETC,pformatetc, STGMEDIUM*,pmedium) \
204     ICOM_METHOD1(HRESULT,QueryGetData,          LPFORMATETC,pformatetc) \
205     ICOM_METHOD2(HRESULT,GetCanonicalFormatEtc, LPFORMATETC,pformatectIn, LPFORMATETC,pformatetcOut) \
206     ICOM_METHOD3(HRESULT,SetData,               LPFORMATETC,pformatetc, STGMEDIUM*,pmedium, BOOL,fRelease) \
207     ICOM_METHOD2(HRESULT,EnumFormatEtc,         DWORD,dwDirection, IEnumFORMATETC**,ppenumFormatEtc) \
208     ICOM_METHOD4(HRESULT,DAdvise,               LPFORMATETC*,pformatetc, DWORD,advf, IAdviseSink*,pAdvSink, DWORD*,pdwConnection) \
209     ICOM_METHOD1(HRESULT,DUnadvise,             DWORD,dwConnection) \
210     ICOM_METHOD1(HRESULT,EnumDAdvise,           IEnumSTATDATA**,ppenumAdvise)
211 #define IDataObject_IMETHODS \
212     IUnknown_IMETHODS \
213     IDataObject_METHODS
214 ICOM_DEFINE(IDataObject,IUnknown)
215 #undef ICOM_INTERFACE
216
217 #ifdef ICOM_CINTERFACE
218 /*** IUnknown methods ***/
219 #define IDataObject_QueryInterface(p,a,b) ICOM_CALL2(QueryInterface,p,a,b)
220 #define IDataObject_AddRef(p)             ICOM_CALL (AddRef,p)
221 #define IDataObject_Release(p)            ICOM_CALL (Release,p)
222 /*** IDataObject methods ***/
223 #define IDataObject_GetData(p,a,b)               ICOM_CALL2(GetData,p,a,b)
224 #define IDataObject_GetDataHere(p,a,b)           ICOM_CALL2(GetDataHere,p,a,b)
225 #define IDataObject_QueryGetData(p,a)            ICOM_CALL1(QueryGetData,p,a)
226 #define IDataObject_GetCanonicalFormatEtc(p,a,b) ICOM_CALL2(GetCanonicalFormatEtc,p,a,b)
227 #define IDataObject_SetData(p,a,b,c)             ICOM_CALL3(SetData,p,a,b,c)
228 #define IDataObject_EnumFormatEtc(p,a,b)         ICOM_CALL2(EnumFormatEtc,p,a,b)
229 #define IDataObject_DAdvise(p,a,b,c,d)           ICOM_CALL4(DAdvise,p,a,b,c,d)
230 #define IDataObject_DUnadvise(p,a)               ICOM_CALL1(DUnadvise,p,a)
231 #define IDataObject_EnumDAdvise(p,a)             ICOM_CALL1(EnumDAdvise,p,a)
232 #endif
233
234
235 /*****************************************************************************
236  * IEnumFORMATETC interface
237  */
238 #define ICOM_INTERFACE IEnumFORMATETC
239 #define IEnumFORMATETC_METHODS \
240     ICOM_METHOD3(HRESULT,Next,  ULONG,celt, FORMATETC*,rgelt, ULONG*,pceltFethed) \
241     ICOM_METHOD1(HRESULT,Skip,  ULONG,celt) \
242     ICOM_METHOD (HRESULT,Reset) \
243     ICOM_METHOD1(HRESULT,Clone, IEnumFORMATETC**,ppenum)
244 #define IEnumFORMATETC_IMETHODS \
245     IUnknown_IMETHODS \
246     IEnumFORMATETC_METHODS
247 ICOM_DEFINE(IEnumFORMATETC,IUnknown)
248 #undef ICOM_INTERFACE
249
250 #ifdef ICOM_CINTERFACE
251 /*** IUnknown methods ***/
252 #define IEnumFORMATETC_QueryInterface(p,a,b) ICOM_CALL2(QueryInterface,p,a,b)
253 #define IEnumFORMATETC_AddRef(p)             ICOM_CALL (AddRef,p)
254 #define IEnumFORMATETC_Release(p)            ICOM_CALL (Release,p)
255 /*** IEnumFORMATETC methods ***/
256 #define IEnumFORMATETC_Next(p,a,b,c) ICOM_CALL3(Next,p,a,b,c)
257 #define IEnumFORMATETC_Skip(p,a)     ICOM_CALL1(Skip,p,a)
258 #define IEnumFORMATETC_Reset(p)      ICOM_CALL (Reset,p)
259 #define IEnumFORMATETC_Clone(p,a)    ICOM_CALL1(Clone,p,a)
260 #endif
261
262
263 /*****************************************************************************
264  * IEnumSTATDATA interface
265  */
266 typedef struct tagSTATDATA
267 {
268     FORMATETC formatetc;
269     DWORD advf;
270     IAdviseSink* pAdvSink;
271     DWORD dwConnection;
272 } STATDATA32;
273
274 #define ICOM_INTERFACE IEnumSTATDATA
275 #define IEnumSTATDATA_METHODS \
276     ICOM_METHOD3(HRESULT,Next,  ULONG,celt, STATDATA32*,rgelt, ULONG*,pceltFethed) \
277     ICOM_METHOD1(HRESULT,Skip,  ULONG,celt) \
278     ICOM_METHOD (HRESULT,Reset) \
279     ICOM_METHOD1(HRESULT,Clone, IEnumSTATDATA**,ppenum)
280 #define IEnumSTATDATA_IMETHODS \
281     IUnknown_IMETHODS \
282     IEnumSTATDATA_METHODS
283 ICOM_DEFINE(IEnumSTATDATA,IUnknown)
284 #undef ICOM_INTERFACE
285
286 #ifdef ICOM_CINTERFACE
287 /*** IUnknown methods ***/
288 #define IEnumSTATDATA_QueryInterface(p,a,b) ICOM_CALL2(QueryInterface,p,a,b)
289 #define IEnumSTATDATA_AddRef(p)             ICOM_CALL (AddRef,p)
290 #define IEnumSTATDATA_Release(p)            ICOM_CALL (Release,p)
291 /*** IEnumSTATDATA methods ***/
292 #define IEnumSTATDATA_Next(p,a,b,c) ICOM_CALL3(Next,p,a,b,c)
293 #define IEnumSTATDATA_Skip(p,a)     ICOM_CALL1(Skip,p,a)
294 #define IEnumSTATDATA_Reset(p)      ICOM_CALL (Reset,p)
295 #define IEnumSTATDATA_Clone(p,a)    ICOM_CALL1(Clone,p,a)
296 #endif
297
298
299 /*****************************************************************************
300  * Additional API
301  */
302
303 /* FIXME: not implemented */
304 HRESULT WINAPI CreateDataCache(LPUNKNOWN pUnkOuter, REFCLSID rclsid, REFIID iid, LPVOID* ppv);
305
306
307 #endif /* __WINE_WINE_OBJ_DATAOBJECT_H */