include/shell.h

   1 /*
   2  *                              Shell Library definitions
   3  */
   4 #ifndef __WINE_SHELL_H
   5 #define __WINE_SHELL_H
   6
   7 #include "windows.h"
   8 #include "winreg.h"
   9 #include "imagelist.h"
  10
  11 #ifndef MAX_PATH
  12 #define MAX_PATH 260
  13 #endif
  14
  15 /****************************************************************************
  16 * shell 16
  17 */
  18 extern void SHELL_LoadRegistry();
  19 extern void SHELL_SaveRegistry();
  20 extern void SHELL_Init();
  21
  22 /* global functions used from shell32 */
  23 extern HINSTANCE32 SHELL_FindExecutable(LPCSTR,LPCSTR ,LPSTR);
  24 extern HGLOBAL16 WINAPI InternalExtractIcon(HINSTANCE16,LPCSTR,UINT16,WORD);
  25
  26 /****************************************************************************
  27 * shell 32
  28 */
  29 /****************************************************************************
  30 * common return codes
  31 */
  32 #define SHELL_ERROR_SUCCESS           0L
  33 #define SHELL_ERROR_BADDB             1L
  34 #define SHELL_ERROR_BADKEY            2L
  35 #define SHELL_ERROR_CANTOPEN          3L
  36 #define SHELL_ERROR_CANTREAD          4L
  37 #define SHELL_ERROR_CANTWRITE         5L
  38 #define SHELL_ERROR_OUTOFMEMORY       6L
  39 #define SHELL_ERROR_INVALID_PARAMETER 7L
  40 #define SHELL_ERROR_ACCESS_DENIED     8L
  41
  42 /****************************************************************************
  43 * common shell file structures
  44 */
  45 #define FO_MOVE           0x0001
  46 #define FO_COPY           0x0002
  47 #define FO_DELETE         0x0003
  48 #define FO_RENAME         0x0004
  49
  50 #define FOF_MULTIDESTFILES         0x0001
  51 #define FOF_CONFIRMMOUSE           0x0002
  52 #define FOF_SILENT                 0x0004
  53 #define FOF_RENAMEONCOLLISION      0x0008
  54 #define FOF_NOCONFIRMATION         0x0010
  55 #define FOF_WANTMAPPINGHANDLE      0x0020
  56 #define FOF_ALLOWUNDO              0x0040
  57 #define FOF_FILESONLY              0x0080
  58 #define FOF_SIMPLEPROGRESS         0x0100
  59 #define FOF_NOCONFIRMMKDIR         0x0200
  60 #define FOF_NOERRORUI              0x0400
  61
  62 typedef WORD FILEOP_FLAGS;
  63
  64 #define PO_DELETE       0x0013
  65 #define PO_RENAME       0x0014
  66 #define PO_PORTCHANGE   0x0020
  67
  68 typedef WORD PRINTEROP_FLAGS;
  69
  70 /******************************
  71 * DROPFILESTRUCT
  72 */
  73 typedef struct {           /* structure for dropped files */
  74         WORD            wSize;
  75         POINT16         ptMousePos;
  76         BOOL16          fInNonClientArea;
  77         /* memory block with filenames follows */
  78 } DROPFILESTRUCT, *LPDROPFILESTRUCT;
  79
  80 /****************************************************************************
  81 * NOTIFYICONDATA
  82 */
  83 typedef struct _NOTIFYICONDATA {
  84         DWORD cbSize;
  85         HWND32 hWnd;
  86         UINT32 uID;
  87         UINT32 uFlags;
  88         UINT32 uCallbackMessage;
  89         HICON32 hIcon;
  90         CHAR szTip[64];
  91 } NOTIFYICONDATA, *PNOTIFYICONDATA;
  92
  93 /****************************************************************************
  94 * SHITEMID, ITEMIDLIST, PIDL API
  95 */
  96 typedef struct
  97 { WORD          cb;     /* nr of bytes in this item */
  98   BYTE          abID[1];/* first byte in this item */
  99 } SHITEMID,*LPSHITEMID;
 100
 101 typedef struct
 102 { SHITEMID mkid; /* first itemid in list */
 103 } ITEMIDLIST,*LPITEMIDLIST,*LPCITEMIDLIST;
 104
 105 LPITEMIDLIST WINAPI ILClone (LPCITEMIDLIST pidl);
 106 LPITEMIDLIST WINAPI ILGetNext(LPITEMIDLIST pidl);
 107 LPITEMIDLIST WINAPI ILCombine(LPCITEMIDLIST iil1,LPCITEMIDLIST iil2);
 108 DWORD WINAPI ILGetSize(LPITEMIDLIST pidl);
 109
 110 DWORD WINAPI SHGetPathFromIDList32A (LPCITEMIDLIST pidl,LPSTR pszPath);
 111 DWORD WINAPI SHGetPathFromIDList32W (LPCITEMIDLIST pidl,LPWSTR pszPath);
 112 #define  SHGetPathFromIDList WINELIB_NAME_AW(SHGetPathFromIDList)
 113
 114 /****************************************************************************
 115 * SHFILEINFO API
 116 */
 117 typedef struct tagSHFILEINFO32A {
 118         HICON32 hIcon;                  /* icon */
 119         int     iIcon;                  /* icon index */
 120         DWORD   dwAttributes;           /* SFGAO_ flags */
 121         CHAR    szDisplayName[MAX_PATH];/* display name (or path) */
 122         CHAR    szTypeName[80];         /* type name */
 123 } SHFILEINFO32A;
 124
 125 typedef struct tagSHFILEINFO32W {
 126         HICON32 hIcon;                  /* icon */
 127         int     iIcon;                  /* icon index */
 128         DWORD   dwAttributes;           /* SFGAO_ flags */
 129         WCHAR   szDisplayName[MAX_PATH];/* display name (or path) */
 130         WCHAR   szTypeName[80];         /* type name */
 131 } SHFILEINFO32W;
 132
 133 DECL_WINELIB_TYPE_AW(SHFILEINFO)
 134
 135 DWORD    WINAPI SHGetFileInfo32A(LPCSTR,DWORD,SHFILEINFO32A*,UINT32,UINT32);
 136 DWORD    WINAPI SHGetFileInfo32W(LPCWSTR,DWORD,SHFILEINFO32W*,UINT32,UINT32);
 137 #define  SHGetFileInfo WINELIB_NAME_AW(SHGetFileInfo)
 138
 139 /****************************************************************************
 140 * SHFILEOPSTRUCT API
 141 */
 142 typedef struct _SHFILEOPSTRUCTA
 143 { HWND32          hwnd;
 144   UINT32          wFunc;
 145   LPCSTR          pFrom;
 146   LPCSTR          pTo;
 147   FILEOP_FLAGS    fFlags;
 148   BOOL32          fAnyOperationsAborted;
 149   LPVOID          hNameMappings;
 150   LPCSTR          lpszProgressTitle;
 151 } SHFILEOPSTRUCT32A, *LPSHFILEOPSTRUCT32A;
 152
 153 typedef struct _SHFILEOPSTRUCTW
 154 { HWND32          hwnd;
 155   UINT32          wFunc;
 156   LPCWSTR         pFrom;
 157   LPCWSTR         pTo;
 158   FILEOP_FLAGS    fFlags;
 159   BOOL32          fAnyOperationsAborted;
 160   LPVOID          hNameMappings;
 161   LPCWSTR         lpszProgressTitle;
 162 } SHFILEOPSTRUCT32W, *LPSHFILEOPSTRUCT32W;
 163
 164 typedef SHFILEOPSTRUCT32A SHFILEOPSTRUCT32;
 165 typedef LPSHFILEOPSTRUCT32A LPSHFILEOPSTRUCT32;
 166
 167 DECL_WINELIB_TYPE_AW(SHFILEOPSTRUCT)
 168
 169 DWORD WINAPI SHFileOperation32(LPSHFILEOPSTRUCT32 lpFileOp);
 170
 171 /****************************************************************************
 172 * APPBARDATA
 173 */
 174 typedef struct _AppBarData {
 175         DWORD   cbSize;
 176         HWND32  hWnd;
 177         UINT32  uCallbackMessage;
 178         UINT32  uEdge;
 179         RECT32  rc;
 180         LPARAM  lParam;
 181 } APPBARDATA, *PAPPBARDATA;
 182
 183 #define SHGFI_ICON              0x000000100     /* get icon */
 184 #define SHGFI_DISPLAYNAME       0x000000200     /* get display name */
 185 #define SHGFI_TYPENAME          0x000000400     /* get type name */
 186 #define SHGFI_ATTRIBUTES        0x000000800     /* get attributes */
 187 #define SHGFI_ICONLOCATION      0x000001000     /* get icon location */
 188 #define SHGFI_EXETYPE           0x000002000     /* return exe type */
 189 #define SHGFI_SYSICONINDEX      0x000004000     /* get system icon index */
 190 #define SHGFI_LINKOVERLAY       0x000008000     /* put a link overlay on icon */
 191 #define SHGFI_SELECTED          0x000010000     /* show icon in selected state */
 192 #define SHGFI_LARGEICON         0x000000000     /* get large icon */
 193 #define SHGFI_SMALLICON         0x000000001     /* get small icon */
 194 #define SHGFI_OPENICON          0x000000002     /* get open icon */
 195 #define SHGFI_SHELLICONSIZE     0x000000004     /* get shell size icon */
 196 #define SHGFI_PIDL              0x000000008     /* pszPath is a pidl */
 197 #define SHGFI_USEFILEATTRIBUTES 0x000000010     /* use passed dwFileAttribute */
 198
 199 /****************************************************************************
 200 * SHChangeNotifyRegister API
 201 */
 202 typedef struct
 203 { LPITEMIDLIST pidl;
 204   DWORD unknown;
 205 } IDSTRUCT;
 206
 207 DWORD WINAPI SHChangeNotifyRegister(HWND32 hwnd,LONG events1,LONG events2,DWORD msg,int count,IDSTRUCT *idlist);
 208 DWORD WINAPI SHChangeNotifyDeregister(LONG x1,LONG x2);
 209
 210 /****************************************************************************
 211 * SHAddToRecentDocs API
 212 */
 213 #define SHARD_PIDL      0x00000001L
 214 #define SHARD_PATH      0x00000002L
 215
 216 DWORD WINAPI SHAddToRecentDocs(UINT32 uFlags, LPCVOID pv);
 217
 218 /****************************************************************************
 219 *  string and path functions
 220 */
 221 LPSTR WINAPI PathAddBackslash(LPSTR path);
 222 LPSTR WINAPI PathCombine(LPSTR target,LPSTR x1,LPSTR x2);
 223 LPSTR WINAPI PathRemoveBlanks(LPSTR str);
 224 LPSTR WINAPI PathFindFilename(LPSTR fn);
 225 /****************************************************************************
 226 *  other functions
 227 */
 228 LPVOID WINAPI SHAlloc(DWORD len);
 229 DWORD WINAPI SHFree(LPVOID x);
 230
 231 #define SE_ERR_SHARE            26
 232 #define SE_ERR_ASSOCINCOMPLETE  27
 233 #define SE_ERR_DDETIMEOUT       28
 234 #define SE_ERR_DDEFAIL          29
 235 #define SE_ERR_DDEBUSY          30
 236 #define SE_ERR_NOASSOC          31
 237
 238 #define CSIDL_DESKTOP           0x0000
 239 #define CSIDL_PROGRAMS          0x0002
 240 #define CSIDL_CONTROLS          0x0003
 241 #define CSIDL_PRINTERS          0x0004
 242 #define CSIDL_PERSONAL          0x0005
 243 #define CSIDL_FAVORITES         0x0006
 244 #define CSIDL_STARTUP           0x0007
 245 #define CSIDL_RECENT            0x0008
 246 #define CSIDL_SENDTO            0x0009
 247 #define CSIDL_BITBUCKET         0x000a
 248 #define CSIDL_STARTMENU         0x000b
 249 #define CSIDL_DESKTOPDIRECTORY  0x0010
 250 #define CSIDL_DRIVES            0x0011
 251 #define CSIDL_NETWORK           0x0012
 252 #define CSIDL_NETHOOD           0x0013
 253 #define CSIDL_FONTS             0x0014
 254 #define CSIDL_TEMPLATES         0x0015
 255
 256 #endif  /* __WINE_SHELL_H */