gdiplus: Use GdipFree instead of HeapFree in GdipDeleteGraphics.
[wine.git] / include / shellapi.h
blob67e89235c9c7f663dd7d4677ef069666a109a991
1 /*
2 * Copyright (C) the Wine project
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19 #ifndef __WINE_SHELLAPI_H
20 #define __WINE_SHELLAPI_H
22 #ifdef __cplusplus
23 extern "C" {
24 #endif /* defined(__cplusplus) */
26 #include <pshpack1.h>
28 DECLARE_HANDLE(HDROP);
30 /******************************************
31 * DragObject
34 typedef struct _DRAGINFOA
35 { UINT uSize;
36 POINT pt;
37 BOOL fNC;
38 LPSTR lpFileList;
39 DWORD grfKeyState;
40 } DRAGINFOA, *LPDRAGINFOA;
42 typedef struct _DRAGINFOW
43 { UINT uSize;
44 POINT pt;
45 BOOL fNC;
46 LPWSTR lpFileList;
47 DWORD grfKeyState;
48 } DRAGINFOW, *LPDRAGINFOW;
50 DECL_WINELIB_TYPE_AW(DRAGINFO)
51 DECL_WINELIB_TYPE_AW(LPDRAGINFO)
53 void WINAPI DragAcceptFiles(HWND hWnd, BOOL b);
54 UINT WINAPI DragQueryFileA(HDROP hDrop, UINT lFile, LPSTR lpszFile, UINT lLength);
55 UINT WINAPI DragQueryFileW(HDROP hDrop, UINT lFile, LPWSTR lpszFile, UINT lLength);
56 #define DragQueryFile WINELIB_NAME_AW(DragQueryFile)
57 void WINAPI DragFinish(HDROP h);
58 BOOL WINAPI DragQueryPoint(HDROP hDrop, POINT *p);
62 /******************************************
63 * Application Bar
65 #define ABM_NEW 0x00000000
66 #define ABM_REMOVE 0x00000001
67 #define ABM_QUERYPOS 0x00000002
68 #define ABM_SETPOS 0x00000003
69 #define ABM_GETSTATE 0x00000004
70 #define ABM_GETTASKBARPOS 0x00000005
71 #define ABM_ACTIVATE 0x00000006
72 #define ABM_GETAUTOHIDEBAR 0x00000007
73 #define ABM_SETAUTOHIDEBAR 0x00000008
74 #define ABM_WINDOWPOSCHANGED 0x00000009
76 #define ABN_STATECHANGE 0x00000000
77 #define ABN_POSCHANGED 0x00000001
78 #define ABN_FULLSCREENAPP 0x00000002
79 #define ABN_WINDOWARRANGE 0x00000003
81 #define ABS_AUTOHIDE 0x00000001
82 #define ABS_ALWAYSONTOP 0x00000002
84 #define ABE_LEFT 0
85 #define ABE_TOP 1
86 #define ABE_RIGHT 2
87 #define ABE_BOTTOM 3
89 typedef struct _AppBarData
90 { DWORD cbSize;
91 HWND hWnd;
92 UINT uCallbackMessage;
93 UINT uEdge;
94 RECT rc;
95 LPARAM lParam;
96 } APPBARDATA, *PAPPBARDATA;
98 UINT_PTR WINAPI SHAppBarMessage(DWORD,PAPPBARDATA);
100 /******************************************
101 * SHGetFileInfo
104 #define SHGFI_LARGEICON 0x000000000 /* get large icon */
105 #define SHGFI_SMALLICON 0x000000001 /* get small icon */
106 #define SHGFI_OPENICON 0x000000002 /* get open icon */
107 #define SHGFI_SHELLICONSIZE 0x000000004 /* get shell size icon */
108 #define SHGFI_PIDL 0x000000008 /* pszPath is a pidl */
109 #define SHGFI_USEFILEATTRIBUTES 0x000000010 /* use passed dwFileAttribute */
110 #define SHGFI_ADDOVERLAYS 0x000000020
111 #define SHGFI_OVERLAYINDEX 0x000000040
112 #define SHGFI_ICON 0x000000100 /* get icon */
113 #define SHGFI_DISPLAYNAME 0x000000200 /* get display name */
114 #define SHGFI_TYPENAME 0x000000400 /* get type name */
115 #define SHGFI_ATTRIBUTES 0x000000800 /* get attributes */
116 #define SHGFI_ICONLOCATION 0x000001000 /* get icon location */
117 #define SHGFI_EXETYPE 0x000002000 /* return exe type */
118 #define SHGFI_SYSICONINDEX 0x000004000 /* get system icon index */
119 #define SHGFI_LINKOVERLAY 0x000008000 /* put a link overlay on icon */
120 #define SHGFI_SELECTED 0x000010000 /* show icon in selected state */
121 #define SHGFI_ATTR_SPECIFIED 0x000020000 /* get only specified attributes */
123 typedef struct tagSHFILEINFOA
124 { HICON hIcon; /* icon */
125 int iIcon; /* icon index */
126 DWORD dwAttributes; /* SFGAO_ flags */
127 CHAR szDisplayName[MAX_PATH];/* display name (or path) */
128 CHAR szTypeName[80]; /* type name */
129 } SHFILEINFOA;
131 typedef struct tagSHFILEINFOW
132 { HICON hIcon; /* icon */
133 int iIcon; /* icon index */
134 DWORD dwAttributes; /* SFGAO_ flags */
135 WCHAR szDisplayName[MAX_PATH];/* display name (or path) */
136 WCHAR szTypeName[80]; /* type name */
137 } SHFILEINFOW;
139 DECL_WINELIB_TYPE_AW(SHFILEINFO)
141 DWORD_PTR WINAPI SHGetFileInfoA(LPCSTR,DWORD,SHFILEINFOA*,UINT,UINT);
142 DWORD_PTR WINAPI SHGetFileInfoW(LPCWSTR,DWORD,SHFILEINFOW*,UINT,UINT);
143 #define SHGetFileInfo WINELIB_NAME_AW(SHGetFileInfo)
145 /******************************************
146 * SHSetFileInfo
149 /******************************************
150 * SHFileOperation
152 #define FO_MOVE 0x0001
153 #define FO_COPY 0x0002
154 #define FO_DELETE 0x0003
155 #define FO_RENAME 0x0004
157 #define FOF_MULTIDESTFILES 0x0001
158 #define FOF_CONFIRMMOUSE 0x0002
159 #define FOF_SILENT 0x0004
160 #define FOF_RENAMEONCOLLISION 0x0008
161 #define FOF_NOCONFIRMATION 0x0010
162 #define FOF_WANTMAPPINGHANDLE 0x0020
163 #define FOF_ALLOWUNDO 0x0040
164 #define FOF_FILESONLY 0x0080
165 #define FOF_SIMPLEPROGRESS 0x0100
166 #define FOF_NOCONFIRMMKDIR 0x0200
167 #define FOF_NOERRORUI 0x0400
168 #define FOF_NOCOPYSECURITYATTRIBS 0x0800
169 #define FOF_NORECURSION 0x1000 /* don't do recursion into directories */
170 #define FOF_NO_CONNECTED_ELEMENTS 0x2000 /* don't do connected files */
171 #define FOF_WANTNUKEWARNING 0x4000 /* during delete operation, warn if delete instead
172 of recycling (even if FOF_NOCONFIRMATION) */
173 #define FOF_NORECURSEREPARSE 0x8000 /* don't do recursion into reparse points */
175 typedef WORD FILEOP_FLAGS;
177 #define PO_DELETE 0x0013
178 #define PO_RENAME 0x0014
179 #define PO_PORTCHANGE 0x0020
180 #define PO_REN_PORT (PO_RENAME | PO_PORTCHANGE)
182 typedef WORD PRINTEROP_FLAGS;
184 typedef struct _SHFILEOPSTRUCTA
185 { HWND hwnd;
186 UINT wFunc;
187 LPCSTR pFrom;
188 LPCSTR pTo;
189 FILEOP_FLAGS fFlags;
190 BOOL fAnyOperationsAborted;
191 LPVOID hNameMappings;
192 LPCSTR lpszProgressTitle;
193 } SHFILEOPSTRUCTA, *LPSHFILEOPSTRUCTA;
195 typedef struct _SHFILEOPSTRUCTW
196 { HWND hwnd;
197 UINT wFunc;
198 LPCWSTR pFrom;
199 LPCWSTR pTo;
200 FILEOP_FLAGS fFlags;
201 BOOL fAnyOperationsAborted;
202 LPVOID hNameMappings;
203 LPCWSTR lpszProgressTitle;
204 } SHFILEOPSTRUCTW, *LPSHFILEOPSTRUCTW;
206 #define SHFILEOPSTRUCT WINELIB_NAME_AW(SHFILEOPSTRUCT)
207 #define LPSHFILEOPSTRUCT WINELIB_NAME_AW(LPSHFILEOPSTRUCT)
209 int WINAPI SHFileOperationA (LPSHFILEOPSTRUCTA lpFileOp);
210 int WINAPI SHFileOperationW (LPSHFILEOPSTRUCTW lpFileOp);
211 #define SHFileOperation WINELIB_NAME_AW(SHFileOperation)
213 typedef struct _SHNAMEMAPPINGA
215 LPSTR pszOldPath;
216 LPSTR pszNewPath;
217 int cchOldPath;
218 int cchNewPath;
219 } SHNAMEMAPPINGA, *LPSHNAMEMAPPINGA;
221 typedef struct _SHNAMEMAPPINGW
223 LPWSTR pszOldPath;
224 LPWSTR pszNewPath;
225 int cchOldPath;
226 int cchNewPath;
227 } SHNAMEMAPPINGW, *LPSHNAMEMAPPINGW;
229 DECL_WINELIB_TYPE_AW(SHNAMEMAPPING)
230 DECL_WINELIB_TYPE_AW(LPSHNAMEMAPPING)
232 void WINAPI SHFreeNameMappings(HANDLE hNameMappings);
234 /******************************************
235 * ShellExecute
237 #define SE_ERR_SHARE 26
238 #define SE_ERR_ASSOCINCOMPLETE 27
239 #define SE_ERR_DDETIMEOUT 28
240 #define SE_ERR_DDEFAIL 29
241 #define SE_ERR_DDEBUSY 30
242 #define SE_ERR_NOASSOC 31
244 HINSTANCE WINAPI ShellExecuteA(HWND,LPCSTR,LPCSTR,LPCSTR,LPCSTR,INT);
245 HINSTANCE WINAPI ShellExecuteW(HWND,LPCWSTR,LPCWSTR,LPCWSTR,LPCWSTR,INT);
246 #define ShellExecute WINELIB_NAME_AW(ShellExecute)
248 #define SE_ERR_FNF 2 /* file not found */
249 #define SE_ERR_PNF 3 /* path not found */
250 #define SE_ERR_ACCESSDENIED 5 /* access denied */
251 #define SE_ERR_OOM 8 /* out of memory */
252 #define SE_ERR_DLLNOTFOUND 32
253 #define SE_ERR_SHARE 26
254 #define SE_ERR_ASSOCINCOMPLETE 27
255 #define SE_ERR_DDETIMEOUT 28
256 #define SE_ERR_DDEFAIL 29
257 #define SE_ERR_DDEBUSY 30
258 #define SE_ERR_NOASSOC 31
260 #define SEE_MASK_CLASSNAME 0x00000001
261 #define SEE_MASK_CLASSKEY 0x00000003
262 #define SEE_MASK_IDLIST 0x00000004
263 #define SEE_MASK_INVOKEIDLIST 0x0000000c
264 #define SEE_MASK_ICON 0x00000010
265 #define SEE_MASK_HOTKEY 0x00000020
266 #define SEE_MASK_NOCLOSEPROCESS 0x00000040
267 #define SEE_MASK_CONNECTNETDRV 0x00000080
268 #define SEE_MASK_NOASYNC 0x00000100
269 #define SEE_MASK_FLAG_DDEWAIT SEE_MASK_NOASYNC
270 #define SEE_MASK_DOENVSUBST 0x00000200
271 #define SEE_MASK_FLAG_NO_UI 0x00000400
272 #define SEE_MASK_UNICODE 0x00004000
273 #define SEE_MASK_NO_CONSOLE 0x00008000
274 #define SEE_MASK_ASYNCOK 0x00100000
275 #define SEE_MASK_HMONITOR 0x00200000
276 #define SEE_MASK_NOZONECHECKS 0x00800000
277 #define SEE_MASK_NOQUERYCLASSSTORE 0x01000000
278 #define SEE_MASK_WAITFORINPUTIDLE 0x02000000
279 #define SEE_MASK_FLAG_LOG_USAGE 0x04000000
281 typedef struct _SHELLEXECUTEINFOA
282 { DWORD cbSize;
283 ULONG fMask;
284 HWND hwnd;
285 LPCSTR lpVerb;
286 LPCSTR lpFile;
287 LPCSTR lpParameters;
288 LPCSTR lpDirectory;
289 INT nShow;
290 HINSTANCE hInstApp;
291 /* Optional fields */
292 LPVOID lpIDList;
293 LPCSTR lpClass;
294 HKEY hkeyClass;
295 DWORD dwHotKey;
296 union
297 { HANDLE hIcon;
298 HANDLE hMonitor;
299 } DUMMYUNIONNAME;
300 HANDLE hProcess;
301 } SHELLEXECUTEINFOA, *LPSHELLEXECUTEINFOA;
303 typedef struct _SHELLEXECUTEINFOW
304 { DWORD cbSize;
305 ULONG fMask;
306 HWND hwnd;
307 LPCWSTR lpVerb;
308 LPCWSTR lpFile;
309 LPCWSTR lpParameters;
310 LPCWSTR lpDirectory;
311 INT nShow;
312 HINSTANCE hInstApp;
313 /* Optional fields*/
314 LPVOID lpIDList;
315 LPCWSTR lpClass;
316 HKEY hkeyClass;
317 DWORD dwHotKey;
318 union
319 { HANDLE hIcon;
320 HANDLE hMonitor;
321 } DUMMYUNIONNAME;
322 HANDLE hProcess;
323 } SHELLEXECUTEINFOW, *LPSHELLEXECUTEINFOW;
325 #define SHELLEXECUTEINFO WINELIB_NAME_AW(SHELLEXECUTEINFO)
326 #define LPSHELLEXECUTEINFO WINELIB_NAME_AW(LPSHELLEXECUTEINFO)
328 BOOL WINAPI ShellExecuteExA(LPSHELLEXECUTEINFOA lpExecInfo);
329 BOOL WINAPI ShellExecuteExW(LPSHELLEXECUTEINFOW lpExecInfo);
330 #define ShellExecuteEx WINELIB_NAME_AW(ShellExecuteEx)
332 void WINAPI WinExecErrorA(HWND hwnd,INT error, LPCSTR lpstrFileName, LPCSTR lpstrTitle);
333 void WINAPI WinExecErrorW(HWND hwnd,INT error, LPCWSTR lpstrFileName, LPCWSTR lpstrTitle);
334 #define WinExecError WINELIB_NAME_AW(WinExecError)
336 /******************************************
337 * Tray Notification
339 /* notifyicondata.uFlags values*/
340 #define NIF_MESSAGE 0x00000001
341 #define NIF_ICON 0x00000002
342 #define NIF_TIP 0x00000004
343 #define NIF_STATE 0x00000008
344 #define NIF_INFO 0x00000010
345 #define NIF_GUID 0x00000020
346 #define NIF_REALTIME 0x00000040
347 #define NIF_SHOWTIP 0x00000080
349 /* notifyicondata.dwState values */
350 #define NIS_HIDDEN 0x00000001
351 #define NIS_SHAREDICON 0x00000002
353 /* notifyicondata.dwInfoFlags values */
354 #define NIIF_NONE 0x00000000
355 #define NIIF_INFO 0x00000001
356 #define NIIF_WARNING 0x00000002
357 #define NIIF_ERROR 0x00000003
358 #define NIIF_USER 0x00000004
359 #define NIIF_ICONMASK 0x0000000f
360 #define NIIF_NOSOUND 0x00000010
361 #define NIIF_LARGEICON 0x00000020
363 /* dwMessage values */
364 #define NIM_ADD 0x00000000
365 #define NIM_MODIFY 0x00000001
366 #define NIM_DELETE 0x00000002
367 #define NIM_SETFOCUS 0x00000003
368 #define NIM_SETVERSION 0x00000004
370 #define NOTIFY_VERSION 3 /* supported by Windows 2000 and later */
371 #define NOTIFY_VERSION_4 4 /* supported by Windows Vista */
373 /* callback message lParam values */
374 #define NIN_SELECT (WM_USER+0)
375 #define NINF_KEY 1
376 #define NIN_KEYSELECT (NIN_SELECT|NINF_KEY) /* WM_USER+1 */
377 #define NIN_BALOONSHOW (WM_USER+2)
378 #define NIN_BALOONHIDE (WM_USER+3)
379 #define NIN_BALOONTIMEOUT (WM_USER+4)
380 #define NIN_BALOONCLICK (WM_USER+5)
381 #define NIN_POPUPOPEN (WM_USER+6)
382 #define NIN_POPUPCLOSE (WM_USER+7)
384 typedef struct _NOTIFYICONDATAA
385 { DWORD cbSize;
386 HWND hWnd;
387 UINT uID;
388 UINT uFlags;
389 UINT uCallbackMessage;
390 HICON hIcon;
391 CHAR szTip[128];
392 DWORD dwState;
393 DWORD dwStateMask;
394 CHAR szInfo[256];
395 union {
396 UINT uTimeout;
397 UINT uVersion;
398 } DUMMYUNIONNAME;
399 CHAR szInfoTitle[64];
400 DWORD dwInfoFlags;
401 GUID guidItem;
402 HICON hBalloonIcon;
403 } NOTIFYICONDATAA, *PNOTIFYICONDATAA;
405 typedef struct _NOTIFYICONDATAW
406 { DWORD cbSize;
407 HWND hWnd;
408 UINT uID;
409 UINT uFlags;
410 UINT uCallbackMessage;
411 HICON hIcon;
412 WCHAR szTip[128];
413 DWORD dwState;
414 DWORD dwStateMask;
415 WCHAR szInfo[256];
416 union {
417 UINT uTimeout;
418 UINT uVersion;
419 } DUMMYUNIONNAME;
420 WCHAR szInfoTitle[64];
421 DWORD dwInfoFlags;
422 GUID guidItem;
423 HICON hBalloonIcon;
424 } NOTIFYICONDATAW, *PNOTIFYICONDATAW;
426 DECL_WINELIB_TYPE_AW(NOTIFYICONDATA)
427 DECL_WINELIB_TYPE_AW(PNOTIFYICONDATA)
429 BOOL WINAPI Shell_NotifyIconA(DWORD dwMessage, PNOTIFYICONDATAA lpData);
430 BOOL WINAPI Shell_NotifyIconW(DWORD dwMessage, PNOTIFYICONDATAW lpData);
432 #define Shell_NotifyIcon WINELIB_NAME_AW(Shell_NotifyIcon)
434 /* pre IE 5.0 */
435 #define NOTIFYICONDATAA_V1_SIZE FIELD_OFFSET(NOTIFYICONDATAA, szTip[64])
436 #define NOTIFYICONDATAW_V1_SIZE FIELD_OFFSET(NOTIFYICONDATAW, szTip[64])
438 /* pre Window XP */
439 #define NOTIFYICONDATAA_V2_SIZE FIELD_OFFSET(NOTIFYICONDATAA, guidItem)
440 #define NOTIFYICONDATAW_V2_SIZE FIELD_OFFSET(NOTIFYICONDATAW, guidItem)
442 /* pre Window Vista */
443 #define NOTIFYICONDATAA_V3_SIZE FIELD_OFFSET(NOTIFYICONDATAA, hBalloonIcon)
444 #define NOTIFYICONDATAW_V3_SIZE FIELD_OFFSET(NOTIFYICONDATAW, hBalloonIcon)
447 /******************************************
448 * Links
451 #define SHGNLI_PIDL 0x01
452 #define SHGNLI_PREFIXNAME 0x02
453 #define SHGNLI_NOUNIQUE 0x04
454 #define SHGNLI_NOLNK 0x08
456 BOOL WINAPI SHGetNewLinkInfoA(LPCSTR,LPCSTR,LPSTR,BOOL*,UINT);
457 BOOL WINAPI SHGetNewLinkInfoW(LPCWSTR,LPCWSTR,LPWSTR,BOOL*,UINT);
458 #define SHGetNewLinkInfo WINELIB_NAME_AW(SHGetNewLinkInfo)
460 /******************************************
461 * Recycle bin
464 typedef struct _SHQUERYRBINFO
466 DWORD cbSize;
467 DWORDLONG i64Size;
468 DWORDLONG i64NumItems;
469 } SHQUERYRBINFO, *LPSHQUERYRBINFO;
471 HRESULT WINAPI SHEmptyRecycleBinA(HWND,LPCSTR,DWORD);
472 HRESULT WINAPI SHEmptyRecycleBinW(HWND,LPCWSTR,DWORD);
473 #define SHEmptyRecycleBin WINELIB_NAME_AW(SHEmptyRecycleBin)
474 HRESULT WINAPI SHQueryRecycleBinA(LPCSTR,LPSHQUERYRBINFO);
475 HRESULT WINAPI SHQueryRecycleBinW(LPCWSTR,LPSHQUERYRBINFO);
476 #define SHQueryRecycleBin WINELIB_NAME_AW(SHQueryRecycleBin)
478 /******************************************
479 * Misc
482 LPWSTR* WINAPI CommandLineToArgvW(LPCWSTR,int*);
483 HICON WINAPI ExtractIconA(HINSTANCE,LPCSTR,UINT);
484 HICON WINAPI ExtractIconW(HINSTANCE,LPCWSTR,UINT);
485 #define ExtractIcon WINELIB_NAME_AW(ExtractIcon)
486 HICON WINAPI ExtractAssociatedIconA(HINSTANCE,LPSTR,LPWORD);
487 HICON WINAPI ExtractAssociatedIconW(HINSTANCE,LPWSTR,LPWORD);
488 #define ExtractAssociatedIcon WINELIB_NAME_AW(ExtractAssociatedIcon)
489 HICON WINAPI ExtractAssociatedIconExA(HINSTANCE,LPSTR,LPWORD,LPWORD);
490 HICON WINAPI ExtractAssociatedIconExW(HINSTANCE,LPWSTR,LPWORD,LPWORD);
491 #define ExtractAssociatedIconEx WINELIB_NAME_AW(ExtractAssociatedIconEx)
492 UINT WINAPI ExtractIconExA(LPCSTR,INT,HICON*,HICON*,UINT);
493 UINT WINAPI ExtractIconExW(LPCWSTR,INT,HICON*,HICON*,UINT);
494 #define ExtractIconEx WINELIB_NAME_AW(ExtractIconEx)
495 HINSTANCE WINAPI FindExecutableA(LPCSTR,LPCSTR,LPSTR);
496 HINSTANCE WINAPI FindExecutableW(LPCWSTR,LPCWSTR,LPWSTR);
497 #define FindExecutable WINELIB_NAME_AW(FindExecutable)
498 BOOL WINAPI ShellAboutA(HWND,LPCSTR,LPCSTR,HICON);
499 BOOL WINAPI ShellAboutW(HWND,LPCWSTR,LPCWSTR,HICON);
500 #define ShellAbout WINELIB_NAME_AW(ShellAbout)
501 int WINAPIV ShellMessageBoxA(HINSTANCE,HWND,LPCSTR,LPCSTR,UINT,...);
502 int WINAPIV ShellMessageBoxW(HINSTANCE,HWND,LPCWSTR,LPCWSTR,UINT,...);
503 #define ShellMessageBox WINELIB_NAME_AW(ShellMessageBox)
504 DWORD WINAPI DoEnvironmentSubstA(LPSTR, UINT);
505 DWORD WINAPI DoEnvironmentSubstW(LPWSTR, UINT);
506 #define DoEnvironmentSubst WINELIB_NAME_AW(DoEnvironmentSubst)
509 #ifdef __cplusplus
510 } /* extern "C" */
511 #endif /* defined(__cplusplus) */
513 #include <poppack.h>
515 #endif /* __WINE_SHELLAPI_H */