KDE 1.x has problems with using XShapeCombineMask when there was no
[wine] / include / shlobj.h
1 #ifndef __WINE_SHLOBJ_H
2 #define __WINE_SHLOBJ_H
3
4 #include "wine/obj_base.h"
5 #include "wine/obj_shelllink.h"
6 #include "wine/obj_shellfolder.h"
7 #include "wine/obj_shellbrowser.h"
8 #include "wine/obj_contextmenu.h"
9 #include "wine/obj_shellextinit.h"
10 #include "wine/obj_extracticon.h"
11 #include "wine/obj_commdlgbrowser.h"
12 #include "wine/obj_dockingwindowframe.h"
13
14 #include "windef.h"
15 #include "winbase.h"    /* WIN32_FIND_* */
16 #include "ole2.h"
17 #include "shell.h"
18 #include "commctrl.h"
19 #include "prsht.h"
20
21 #ifdef __cplusplus
22 extern "C" {
23 #endif /* defined(__cplusplus) */
24
25 /*****************************************************************************
26  * Predeclare interfaces
27  */
28 typedef struct IShellIcon IShellIcon, *LPSHELLICON;
29
30
31 /*****************************************************************************
32  * IContextMenu interface
33  */
34
35
36 /* DATAOBJECT_InitShellIDList*/
37 #define CFSTR_SHELLIDLIST       "Shell IDList Array"      /* CF_IDLIST */
38
39 extern UINT cfShellIDList;
40
41 typedef struct
42 {       UINT cidl;
43         UINT aoffset[1];
44 } CIDA, *LPCIDA,*LPIDA;
45
46 #define CFSTR_SHELLIDLISTOFFSET "Shell Object Offsets"    /* CF_OBJECTPOSITIONS */
47 #define CFSTR_NETRESOURCES      "Net Resource"            /* CF_NETRESOURCE */
48
49 /* DATAOBJECT_InitFileGroupDesc */
50 #define CFSTR_FILEDESCRIPTORA   "FileGroupDescriptor"     /* CF_FILEGROUPDESCRIPTORA */
51 extern UINT cfFileGroupDesc;
52
53 #define CFSTR_FILEDESCRIPTORW   "FileGroupDescriptorW"    /* CF_FILEGROUPDESCRIPTORW */
54
55 /* DATAOBJECT_InitFileContents*/
56 #define CFSTR_FILECONTENTS      "FileContents"            /* CF_FILECONTENTS */
57 extern UINT cfFileContents;
58
59 #define CFSTR_FILENAMEA         "FileName"                /* CF_FILENAMEA */
60 #define CFSTR_FILENAMEW         "FileNameW"               /* CF_FILENAMEW */
61 #define CFSTR_PRINTERGROUP      "PrinterFriendlyName"     /* CF_PRINTERS */
62 #define CFSTR_FILENAMEMAPA      "FileNameMap"             /* CF_FILENAMEMAPA */
63 #define CFSTR_FILENAMEMAPW      "FileNameMapW"            /* CF_FILENAMEMAPW */
64 #define CFSTR_SHELLURL          "UniformResourceLocator"
65 #define CFSTR_PREFERREDDROPEFFECT "Preferred DropEffect"
66 #define CFSTR_PERFORMEDDROPEFFECT "Performed DropEffect"
67 #define CFSTR_PASTESUCCEEDED    "Paste Succeeded"
68 #define CFSTR_INDRAGLOOP        "InShellDragLoop"
69
70
71 /************************************************************************
72 * IShellView interface
73 */
74
75 typedef GUID SHELLVIEWID;
76 #define SV_CLASS_NAME   ("SHELLDLL_DefView")
77
78 /****************************************************************************
79  * IShellIcon interface
80  */
81
82 #define ICOM_INTERFACE IShellIcon
83 #define IShellIcon_METHODS \
84     ICOM_METHOD3(HRESULT, GetIconOf,     LPCITEMIDLIST,pidl, UINT,flags, LPINT,lpIconIndex)
85 #define IShellIcon_IMETHODS \
86     IUnknown_IMETHODS \
87     IShellIcon_METHODS
88 ICOM_DEFINE(IShellIcon, IUnknown)
89 #undef ICOM_INTERFACE
90
91 /*** IUnknown methods ***/
92 #define IShellIcon_QueryInterface(p,a,b)      ICOM_CALL2(QueryInterface,p,a,b)
93 #define IShellIcon_AddRef(p)                  ICOM_CALL (AddRef,p)
94 #define IShellIcon_Release(p)                 ICOM_CALL (Release,p)
95 /*** IShellIcon methods ***/
96 #define IShellIcon_GetIconOf(p,a,b,c)         ICOM_CALL3(GetIconOf,p,a,b,c)
97
98 /****************************************************************************
99  * Shell Execute API
100  */
101 #define SE_ERR_FNF              2       /* file not found */
102 #define SE_ERR_PNF              3       /* path not found */
103 #define SE_ERR_ACCESSDENIED     5       /* access denied */
104 #define SE_ERR_OOM              8       /* out of memory */
105 #define SE_ERR_DLLNOTFOUND      32
106 #define SE_ERR_SHARE                    26
107 #define SE_ERR_ASSOCINCOMPLETE          27
108 #define SE_ERR_DDETIMEOUT               28
109 #define SE_ERR_DDEFAIL                  29
110 #define SE_ERR_DDEBUSY                  30
111 #define SE_ERR_NOASSOC                  31
112
113 #define SEE_MASK_CLASSNAME        0x00000001
114 #define SEE_MASK_CLASSKEY         0x00000003
115 #define SEE_MASK_IDLIST           0x00000004
116 #define SEE_MASK_INVOKEIDLIST     0x0000000c
117 #define SEE_MASK_ICON             0x00000010
118 #define SEE_MASK_HOTKEY           0x00000020
119 #define SEE_MASK_NOCLOSEPROCESS   0x00000040
120 #define SEE_MASK_CONNECTNETDRV    0x00000080
121 #define SEE_MASK_FLAG_DDEWAIT     0x00000100
122 #define SEE_MASK_DOENVSUBST       0x00000200
123 #define SEE_MASK_FLAG_NO_UI       0x00000400
124 #define SEE_MASK_UNICODE          0x00004000
125 #define SEE_MASK_NO_CONSOLE       0x00008000
126 #define SEE_MASK_ASYNCOK          0x00100000
127 #define SEE_MASK_HMONITOR         0x00200000
128
129 typedef struct _SHELLEXECUTEINFOA
130 {       DWORD cbSize;
131         ULONG fMask;
132         HWND hwnd;
133         LPCSTR   lpVerb;
134         LPCSTR   lpFile;
135         LPCSTR   lpParameters;
136         LPCSTR   lpDirectory;
137        INT nShow;
138         HINSTANCE hInstApp;
139         /* Optional fields */
140         LPVOID lpIDList;
141         LPCSTR   lpClass;
142         HKEY hkeyClass;
143         DWORD dwHotKey;
144         union 
145         { HANDLE hIcon;
146           HANDLE hMonitor;
147         } DUMMYUNIONNAME;
148         HANDLE hProcess;
149 } SHELLEXECUTEINFOA, *LPSHELLEXECUTEINFOA;
150
151 typedef struct _SHELLEXECUTEINFOW
152 {       DWORD cbSize;
153         ULONG fMask;
154         HWND hwnd;
155         LPCWSTR  lpVerb;
156         LPCWSTR  lpFile;
157         LPCWSTR  lpParameters;
158         LPCWSTR  lpDirectory;
159        INT nShow;
160         HINSTANCE hInstApp;
161         /* Optional fields*/
162         LPVOID lpIDList;
163         LPCWSTR  lpClass;
164         HKEY hkeyClass;
165         DWORD dwHotKey;
166         union
167         { HANDLE hIcon;
168           HANDLE hMonitor;
169         } DUMMYUNIONNAME;
170         HANDLE hProcess;
171 } SHELLEXECUTEINFOW, *LPSHELLEXECUTEINFOW;
172
173 #define SHELLEXECUTEINFO   WINELIB_NAME_AW(SHELLEXECUTEINFO)
174 #define LPSHELLEXECUTEINFO WINELIB_NAME_AW(LPSHELLEXECUTEINFO)
175
176 BOOL WINAPI ShellExecuteExA(LPSHELLEXECUTEINFOA lpExecInfo);
177 BOOL WINAPI ShellExecuteExW(LPSHELLEXECUTEINFOW lpExecInfo);
178 #define ShellExecuteEx  WINELIB_NAME_AW(ShellExecuteEx)
179
180 void WINAPI WinExecErrorA(HWND hwnd,INT error, LPCSTR lpstrFileName, LPCSTR lpstrTitle);
181 void WINAPI WinExecErrorW(HWND hwnd,INT error, LPCWSTR lpstrFileName, LPCWSTR lpstrTitle);
182 #define WinExecError  WINELIB_NAME_AW(WinExecError)
183
184
185
186 /****************************************************************************
187  * SHBrowseForFolder API
188  */
189 typedef INT CALLBACK (*BFFCALLBACK)(HWND hwnd, UINT uMsg, LPARAM lParam, LPARAM lpData);
190
191 typedef struct tagBROWSEINFOA {
192     HWND        hwndOwner;
193     LPCITEMIDLIST pidlRoot;
194     LPSTR         pszDisplayName;
195     LPCSTR        lpszTitle;
196     UINT        ulFlags;
197     BFFCALLBACK   lpfn;
198     LPARAM        lParam;
199     INT         iImage;
200 } BROWSEINFOA, *PBROWSEINFOA, *LPBROWSEINFOA;
201
202 typedef struct tagBROWSEINFOW {
203     HWND        hwndOwner;
204     LPCITEMIDLIST pidlRoot;
205     LPWSTR        pszDisplayName;
206     LPCWSTR       lpszTitle;
207     UINT        ulFlags;
208     BFFCALLBACK   lpfn;
209     LPARAM        lParam;
210     INT         iImage;
211 } BROWSEINFOW, *PBROWSEINFOW, *LPBROWSEINFOW; 
212
213 #define BROWSEINFO   WINELIB_NAME_AW(BROWSEINFO)
214 #define PBROWSEINFO  WINELIB_NAME_AW(PBROWSEINFO)
215 #define LPBROWSEINFO WINELIB_NAME_AW(LPBROWSEINFO)
216
217 /* Browsing for directory. */
218 #define BIF_RETURNONLYFSDIRS   0x0001
219 #define BIF_DONTGOBELOWDOMAIN  0x0002
220 #define BIF_STATUSTEXT         0x0004
221 #define BIF_RETURNFSANCESTORS  0x0008
222 #define BIF_EDITBOX            0x0010
223 #define BIF_VALIDATE           0x0020
224  
225 #define BIF_BROWSEFORCOMPUTER  0x1000
226 #define BIF_BROWSEFORPRINTER   0x2000
227 #define BIF_BROWSEINCLUDEFILES 0x4000
228
229 /* message from browser */
230 #define BFFM_INITIALIZED        1
231 #define BFFM_SELCHANGED         2
232 #define BFFM_VALIDATEFAILEDA    3   /* lParam:szPath ret:1(cont),0(EndDialog) */
233 #define BFFM_VALIDATEFAILEDW    4   /* lParam:wzPath ret:1(cont),0(EndDialog) */
234
235 /* messages to browser */
236 #define BFFM_SETSTATUSTEXTA     (WM_USER+100)
237 #define BFFM_ENABLEOK           (WM_USER+101)
238 #define BFFM_SETSELECTIONA      (WM_USER+102)
239 #define BFFM_SETSELECTIONW      (WM_USER+103)
240 #define BFFM_SETSTATUSTEXTW     (WM_USER+104)
241
242 LPITEMIDLIST WINAPI SHBrowseForFolderA(LPBROWSEINFOA lpbi);
243 LPITEMIDLIST WINAPI SHBrowseForFolderW(LPBROWSEINFOW lpbi);
244 #define SHBrowseForFolder        WINELIB_NAME_AW(SHBrowseForFolder)
245 #define BFFM_SETSTATUSTEXT  WINELIB_NAME_AW(BFFM_SETSTATUSTEXT)
246 #define BFFM_SETSELECTION   WINELIB_NAME_AW(BFFM_SETSELECTION)
247 #define BFFM_VALIDATEFAILED WINELIB_NAME_AW(BFFM_VALIDATEFAILED)
248
249 /****************************************************************************
250 *       SHGetDataFromIDList API
251 */
252 #define SHGDFIL_FINDDATA        1
253 #define SHGDFIL_NETRESOURCE     2
254 #define SHGDFIL_DESCRIPTIONID   3
255
256 #define SHDID_ROOT_REGITEM          1
257 #define SHDID_FS_FILE               2
258 #define SHDID_FS_DIRECTORY          3
259 #define SHDID_FS_OTHER              4
260 #define SHDID_COMPUTER_DRIVE35      5
261 #define SHDID_COMPUTER_DRIVE525     6
262 #define SHDID_COMPUTER_REMOVABLE    7
263 #define SHDID_COMPUTER_FIXED        8
264 #define SHDID_COMPUTER_NETDRIVE     9
265 #define SHDID_COMPUTER_CDROM        10
266 #define SHDID_COMPUTER_RAMDISK      11
267 #define SHDID_COMPUTER_OTHER        12
268 #define SHDID_NET_DOMAIN            13
269 #define SHDID_NET_SERVER            14
270 #define SHDID_NET_SHARE             15
271 #define SHDID_NET_RESTOFNET         16
272 #define SHDID_NET_OTHER             17
273
274 typedef struct _SHDESCRIPTIONID 
275 {   DWORD   dwDescriptionId;
276     CLSID   clsid;
277 } SHDESCRIPTIONID, *LPSHDESCRIPTIONID;
278
279 HRESULT WINAPI SHGetDataFromIDListA(LPSHELLFOLDER psf, LPCITEMIDLIST pidl, int nFormat, LPVOID pv, int cb);
280 HRESULT WINAPI SHGetDataFromIDListW(LPSHELLFOLDER psf, LPCITEMIDLIST pidl, int nFormat, LPVOID pv, int cb);
281 #define  SHGetDataFromIDList WINELIB_NAME_AW(SHGetDataFromIDList)
282
283 BOOL WINAPI SHGetSpecialFolderPathA (HWND hwndOwner,LPSTR szPath,DWORD csidl,BOOL bCreate);
284 BOOL WINAPI SHGetSpecialFolderPathW (HWND hwndOwner,LPWSTR szPath,DWORD csidl,BOOL bCreate);
285 #define  SHGetSpecialFolderPath WINELIB_NAME_AW(SHGetSpecialFolderPath)
286
287 HRESULT WINAPI SHGetSpecialFolderLocation(HWND hwndOwner, INT nFolder, LPITEMIDLIST * ppidl);
288
289 /****************************************************************************
290 * shlview structures
291 */
292
293 /*
294 * IShellFolderViewCallback Callback
295 *  This "callback" is called by the shells default IShellView implementation (that
296 *  we got using SHCreateShellViewEx()), to notify us of the various things that
297 *  are happening to the shellview (and ask for things too).
298 *
299 *  You don't have to support anything here - anything you don't want to 
300 *  handle, the shell will do itself if you just return E_NOTIMPL. This parameters
301 *  that the shell passes to this function are entirely undocumented.
302 *
303 *  HOWEVER, as the cabview sample as originally written used this callback, the
304 *  writers implemented the callback mechanism on top of their own IShellView.
305 *  Look there for some clues on what to do here.
306 */
307
308 typedef HRESULT CALLBACK (*SHELLVIEWPROC)(DWORD dwUserParam,LPSHELLFOLDER psf,
309                          HWND hwnd,UINT uMsg,UINT wParam,LPARAM lParam);
310
311 /* NF valid values for the "viewmode" item of the SHELLTEMPLATE*/
312 #define NF_INHERITVIEW    0x0000
313 #define NF_LOCALVIEW        0x0001
314
315 typedef struct _SHELLVIEWDATA   /* idl */
316 { DWORD           dwSize;
317   LPSHELLFOLDER   pShellFolder;
318   DWORD           dwUserParam;
319   LPCITEMIDLIST   pidl;
320   DWORD           v3;        /* always 0 */
321   SHELLVIEWPROC   pCallBack;
322   DWORD           viewmode;  /* NF_* enum */
323 } SHELLVIEWDATA, * LPSHELLVIEWDATA;
324
325 DWORD WINAPI SHGetMalloc(LPMALLOC *lpmal) ;
326
327 /**********************************************************************
328  * SHGetSettings ()
329  */
330 typedef struct
331 {       BOOL fShowAllObjects : 1;
332         BOOL fShowExtensions : 1;
333         BOOL fNoConfirmRecycle : 1;
334         BOOL fShowSysFiles : 1;
335
336         BOOL fShowCompColor : 1;
337         BOOL fDoubleClickInWebView : 1;
338         BOOL fDesktopHTML : 1;
339         BOOL fWin95Classic : 1;
340
341         BOOL fDontPrettyPath : 1;
342         BOOL fShowAttribCol : 1;
343         BOOL fMapNetDrvBtn : 1;
344         BOOL fShowInfoTip : 1;
345
346         BOOL fHideIcons : 1;
347         UINT fRestFlags : 3;
348 } SHELLFLAGSTATE, * LPSHELLFLAGSTATE;
349
350 void WINAPI SHGetSettings(LPSHELLFLAGSTATE lpsfs, DWORD dwMask, DWORD dwx);
351
352 #define SSF_SHOWALLOBJECTS              0x0001
353 #define SSF_SHOWEXTENSIONS              0x0002
354 #define SSF_SHOWCOMPCOLOR               0x0008
355 #define SSF_SHOWSYSFILES                0x0020
356 #define SSF_DOUBLECLICKINWEBVIEW        0x0080
357 #define SSF_SHOWATTRIBCOL               0x0100
358 #define SSF_DESKTOPHTML                 0x0200
359 #define SSF_WIN95CLASSIC                0x0400
360 #define SSF_DONTPRETTYPATH              0x0800
361 #define SSF_SHOWINFOTIP                 0x2000
362 #define SSF_MAPNETDRVBUTTON             0x1000
363 #define SSF_NOCONFIRMRECYCLE            0x8000
364 #define SSF_HIDEICONS                   0x4000
365
366 /**********************************************************************
367  * SHChangeNotify
368  */
369 #define SHCNE_RENAMEITEM        0x00000001
370 #define SHCNE_CREATE            0x00000002
371 #define SHCNE_DELETE            0x00000004
372 #define SHCNE_MKDIR             0x00000008
373 #define SHCNE_RMDIR             0x00000010
374 #define SHCNE_MEDIAINSERTED     0x00000020
375 #define SHCNE_MEDIAREMOVED      0x00000040
376 #define SHCNE_DRIVEREMOVED      0x00000080
377 #define SHCNE_DRIVEADD          0x00000100
378 #define SHCNE_NETSHARE          0x00000200
379 #define SHCNE_NETUNSHARE        0x00000400
380 #define SHCNE_ATTRIBUTES        0x00000800
381 #define SHCNE_UPDATEDIR         0x00001000
382 #define SHCNE_UPDATEITEM        0x00002000
383 #define SHCNE_SERVERDISCONNECT  0x00004000
384 #define SHCNE_UPDATEIMAGE       0x00008000
385 #define SHCNE_DRIVEADDGUI       0x00010000
386 #define SHCNE_RENAMEFOLDER      0x00020000
387 #define SHCNE_FREESPACE         0x00040000
388
389 #define SHCNE_EXTENDED_EVENT    0x04000000
390 #define SHCNE_ASSOCCHANGED      0x08000000
391 #define SHCNE_DISKEVENTS        0x0002381F
392 #define SHCNE_GLOBALEVENTS      0x0C0581E0
393 #define SHCNE_ALLEVENTS         0x7FFFFFFF
394 #define SHCNE_INTERRUPT         0x80000000
395
396 #define SHCNEE_ORDERCHANGED     0x00000002
397
398 #define SHCNF_IDLIST            0x0000
399 #define SHCNF_PATHA             0x0001
400 #define SHCNF_PRINTERA          0x0002
401 #define SHCNF_DWORD             0x0003
402 #define SHCNF_PATHW             0x0005
403 #define SHCNF_PRINTERW          0x0006
404 #define SHCNF_TYPE              0x00FF
405 #define SHCNF_FLUSH             0x1000
406 #define SHCNF_FLUSHNOWAIT       0x2000
407
408 void WINAPI SHChangeNotifyA(LONG wEventId, UINT uFlags, LPCVOID dwItem1, LPCVOID dwItem2);
409 void WINAPI SHChangeNotifyW(LONG wEventId, UINT uFlags, LPCVOID dwItem1, LPCVOID dwItem2);
410 #define  SHChangeNotify WINELIB_NAME_AW(SHChangeNotify)
411
412 /****************************************************************************
413 * SHGetSpecialFolderLocation API
414 */
415 HRESULT WINAPI SHGetSpecialFolderLocation(HWND, INT, LPITEMIDLIST *);
416
417 #define CSIDL_DESKTOP           0x0000
418 #define CSIDL_INTERNET          0x0001
419 #define CSIDL_PROGRAMS          0x0002
420 #define CSIDL_CONTROLS          0x0003
421 #define CSIDL_PRINTERS          0x0004
422 #define CSIDL_PERSONAL          0x0005
423 #define CSIDL_FAVORITES         0x0006
424 #define CSIDL_STARTUP           0x0007
425 #define CSIDL_RECENT            0x0008
426 #define CSIDL_SENDTO            0x0009
427 #define CSIDL_BITBUCKET         0x000a
428 #define CSIDL_STARTMENU         0x000b
429 #define CSIDL_DESKTOPDIRECTORY  0x0010
430 #define CSIDL_DRIVES            0x0011
431 #define CSIDL_NETWORK           0x0012
432 #define CSIDL_NETHOOD           0x0013
433 #define CSIDL_FONTS             0x0014
434 #define CSIDL_TEMPLATES         0x0015
435 #define CSIDL_COMMON_STARTMENU  0x0016
436 #define CSIDL_COMMON_PROGRAMS   0X0017
437 #define CSIDL_COMMON_STARTUP    0x0018
438 #define CSIDL_COMMON_DESKTOPDIRECTORY   0x0019
439 #define CSIDL_APPDATA           0x001a
440 #define CSIDL_PRINTHOOD         0x001b
441 #define CSIDL_ALTSTARTUP        0x001d
442 #define CSIDL_COMMON_ALTSTARTUP 0x001e
443 #define CSIDL_COMMON_FAVORITES  0x001f
444 #define CSIDL_INTERNET_CACHE    0x0020
445 #define CSIDL_COOKIES           0x0021
446 #define CSIDL_HISTORY           0x0022
447 #define CSIDL_COMMON_APPDATA    0x0023
448 #define CSIDL_WINDOWS           0x0024
449 #define CSIDL_SYSTEM            0x0025
450 #define CSIDL_PROGRAM_FILES     0x0026
451 #define CSIDL_MYPICTURES        0x0027
452 #define CSIDL_PROFILE           0x0028
453 #define CSIDL_SYSTEMX86         0x0029
454 #define CSIDL_PROGRAM_FILESX86  0x002a
455 #define CSIDL_PROGRAM_FILES_COMMON      0x002b
456 #define CSIDL_PROGRAM_FILES_COMMONX86   0x002c
457 #define CSIDL_COMMON_TEMPLATES  0x002d
458 #define CSIDL_COMMON_DOCUMENTS  0x002e
459 #define CSIDL_COMMON_ADMINTOOLS 0x002f
460 #define CSIDL_ADMINTOOLS        0x0030
461 #define CSIDL_CONNECTIONS       0x0031
462 #define CSIDL_FOLDER_MASK       0x00ff
463
464 #define CSIDL_FLAG_DONT_VERIFY  0x4000
465 #define CSIDL_FLAG_CREATE       0x8000
466
467 #define CSIDL_FLAG_MASK         0xff00
468
469 /*
470  * DROPFILES for CF_HDROP and CF_PRINTERS
471  */
472 typedef struct _DROPFILES
473 {
474   DWORD pFiles;
475   POINT pt;
476   BOOL  fNC;
477   BOOL  fWide;
478 } DROPFILES;
479
480 #ifdef __cplusplus
481 } /* extern "C" */
482 #endif /* defined(__cplusplus) */
483
484 #endif /* __WINE_SHLOBJ_H */