include/shell.h

   1 /*
   2  *                              Shell Library definitions
   3  */
   4 #ifndef __WINE_SHELL_H
   5 #define __WINE_SHELL_H
   6
   7 #include "windef.h"
   8
   9 #ifdef __cplusplus
  10 extern "C" {
  11 #endif /* defined(__cplusplus) */
  12
  13 /****************************************************************************
  14 * shell 16
  15 */
  16 extern void SHELL_LoadRegistry(void);
  17 extern void SHELL_SaveRegistry(void);
  18 extern void SHELL_InitRegistrySaving(void);
  19
  20 /* global functions used from shell32 */
  21 extern HINSTANCE SHELL_FindExecutable(LPCSTR,LPCSTR ,LPSTR);
  22 extern HGLOBAL16 WINAPI InternalExtractIcon16(HINSTANCE16,LPCSTR,UINT16,WORD);
  23
  24 /****************************************************************************
  25 * shell 32
  26 */
  27 /****************************************************************************
  28 * common return codes
  29 */
  30 #define SHELL_ERROR_SUCCESS           0L
  31 #define SHELL_ERROR_BADDB             1L
  32 #define SHELL_ERROR_BADKEY            2L
  33 #define SHELL_ERROR_CANTOPEN          3L
  34 #define SHELL_ERROR_CANTREAD          4L
  35 #define SHELL_ERROR_CANTWRITE         5L
  36 #define SHELL_ERROR_OUTOFMEMORY       6L
  37 #define SHELL_ERROR_INVALID_PARAMETER 7L
  38 #define SHELL_ERROR_ACCESS_DENIED     8L
  39
  40 /****************************************************************************
  41 * common shell file structures
  42 */
  43 /******************************
  44 * DRAG&DROP API
  45 */
  46 typedef struct {           /* structure for dropped files */
  47         WORD            wSize;
  48         POINT16         ptMousePos;
  49         BOOL16          fInNonClientArea;
  50         /* memory block with filenames follows */
  51 } DROPFILESTRUCT16, *LPDROPFILESTRUCT16;
  52
  53 typedef struct {           /* structure for dropped files */
  54         DWORD           lSize;
  55         POINT           ptMousePos;
  56         BOOL            fInNonClientArea;
  57         BOOL          fWideChar;
  58         /* memory block with filenames follows */
  59 } DROPFILESTRUCT, *LPDROPFILESTRUCT;
  60
  61
  62 /****************************************************************************
  63 * SHITEMID, ITEMIDLIST, PIDL API
  64 */
  65 #include "pshpack1.h"
  66 typedef struct
  67 { WORD  cb;     /* nr of bytes in this item */
  68   BYTE  abID[1];/* first byte in this item */
  69 } SHITEMID,*LPSHITEMID;
  70
  71 typedef struct
  72 { SHITEMID mkid; /* first itemid in list */
  73 } ITEMIDLIST,*LPITEMIDLIST,*LPCITEMIDLIST;
  74 #include "poppack.h"
  75
  76 BOOL WINAPI SHGetPathFromIDListA (LPCITEMIDLIST pidl,LPSTR pszPath);
  77 BOOL WINAPI SHGetPathFromIDListW (LPCITEMIDLIST pidl,LPWSTR pszPath);
  78 #define  SHGetPathFromIDList WINELIB_NAME_AW(SHGetPathFromIDList)
  79
  80 /****************************************************************************
  81 * SHAddToRecentDocs API
  82 */
  83 #define SHARD_PIDL      0x00000001L
  84 #define SHARD_PATH      0x00000002L
  85
  86 DWORD WINAPI SHAddToRecentDocs(UINT uFlags, LPCVOID pv);
  87
  88 /****************************************************************************
  89 * SHGetSpecialFolderLocation API
  90 */
  91 HRESULT WINAPI SHGetSpecialFolderLocation(HWND, INT, LPITEMIDLIST *);
  92 /****************************************************************************
  93 *  string and path functions
  94 */
  95 BOOL WINAPI PathIsRootA(LPCSTR x);
  96 BOOL WINAPI PathIsRootW(LPCWSTR x);
  97 #define  PathIsRoot WINELIB_NAME_AW(PathIsRoot)
  98 BOOL WINAPI PathIsRootAW(LPCVOID x);
  99
 100 LPSTR  WINAPI PathAddBackslashA(LPSTR path);
 101 LPWSTR WINAPI PathAddBackslashW(LPWSTR path);
 102 #define  PathAddBackslash WINELIB_NAME_AW(PathAddBackslash)
 103 LPVOID  WINAPI PathAddBackslashAW(LPVOID path);
 104
 105 BOOL  WINAPI PathQualifyA(LPCSTR path);
 106 BOOL WINAPI PathQualifyW(LPCWSTR path);
 107 #define  PathQualify WINELIB_NAME_AW(PathQualify)
 108 BOOL  WINAPI PathQualifyAW(LPCVOID path);
 109
 110 LPSTR  WINAPI PathQuoteSpacesA(LPCSTR path);
 111 LPWSTR WINAPI PathQuoteSpacesW(LPCWSTR path);
 112 #define  PathQuoteSpaces WINELIB_NAME_AW(PathQuoteSpaces)
 113 LPVOID  WINAPI PathQuoteSpacesAW(LPCVOID path);
 114
 115 LPSTR  WINAPI PathCombineA(LPSTR szDest, LPCSTR lpszDir, LPCSTR lpszFile);
 116 LPWSTR WINAPI PathCombineW(LPWSTR szDest, LPCWSTR lpszDir, LPCWSTR lpszFile);
 117 #define  PathCombine WINELIB_NAME_AW(PathCombine)
 118 LPVOID WINAPI PathCombineAW(LPVOID szDest, LPCVOID lpszDir, LPCVOID lpszFile);
 119
 120 LPCSTR WINAPI PathFindExtensionA(LPCSTR path);
 121 LPCWSTR WINAPI PathFindExtensionW(LPCWSTR path);
 122 #define  PathFindExtension WINELIB_NAME_AW(PathFindExtension)
 123 LPCVOID WINAPI PathFindExtensionAW(LPCVOID path);
 124
 125 LPCSTR WINAPI PathGetExtensionA(LPCSTR path, DWORD y, DWORD x);
 126 LPCWSTR WINAPI PathGetExtensionW(LPCWSTR path, DWORD y, DWORD x);
 127 #define  PathGetExtension WINELIB_NAME_AW(PathGetExtension)
 128 LPCVOID WINAPI PathGetExtensionAW(LPCVOID path, DWORD y, DWORD x);
 129
 130 LPCSTR WINAPI PathFindFilenameA(LPCSTR path);
 131 LPCWSTR WINAPI PathFindFilenameW(LPCWSTR path);
 132 #define  PathFindFilename WINELIB_NAME_AW(PathFindFilename)
 133 LPCVOID WINAPI PathFindFilenameAW(LPCVOID path);
 134
 135 BOOL WINAPI PathMatchSpecA(LPCSTR x, LPCSTR y);
 136 BOOL WINAPI PathMatchSpecW(LPCWSTR x, LPCWSTR y);
 137 #define  PathMatchSpec WINELIB_NAME_AW(PathMatchSpec)
 138 BOOL WINAPI PathMatchSpecAW(LPVOID x, LPVOID y);
 139
 140 LPSTR WINAPI PathRemoveBlanksA(LPSTR str);
 141 LPWSTR WINAPI PathRemoveBlanksW(LPWSTR str);
 142 #define  PathRemoveBlanks WINELIB_NAME_AW(PathRemoveBlanks)
 143 LPVOID WINAPI PathRemoveBlanksAW(LPVOID str);
 144
 145 BOOL WINAPI PathIsRelativeA(LPCSTR str);
 146 BOOL WINAPI PathIsRelativeW(LPCWSTR str);
 147 #define  PathIsRelative WINELIB_NAME_AW(PathIsRelative)
 148 BOOL WINAPI PathIsRelativeAW(LPCVOID str);
 149
 150 BOOL WINAPI PathIsUNCA(LPCSTR str);
 151 BOOL WINAPI PathIsUNCW(LPCWSTR str);
 152 #define  PathIsUNC WINELIB_NAME_AW(PathIsUNC)
 153 BOOL WINAPI PathIsUNCAW(LPCVOID str);
 154
 155 BOOL WINAPI PathIsURLA(LPCSTR str);
 156 BOOL WINAPI PathIsURLW(LPCWSTR str);
 157 #define  PathIsURL WINELIB_NAME_AW(PathIsURL)
 158 BOOL WINAPI PathIsURLAW(LPCVOID str);
 159
 160 BOOL WINAPI PathFindOnPathA(LPSTR sFile, LPCSTR sOtherDirs);
 161 BOOL WINAPI PathFindOnPathW(LPWSTR sFile, LPCWSTR sOtherDirs);
 162 #define PathFindOnPath WINELIB_NAME_AW(PathFindOnPath)
 163 BOOL WINAPI PathFindOnPathAW(LPVOID sFile, LPCVOID sOtherDirs);
 164
 165 LPSTR WINAPI StrFormatByteSizeA ( DWORD dw, LPSTR pszBuf, UINT cchBuf );
 166 LPWSTR WINAPI StrFormatByteSizeW ( DWORD dw, LPWSTR pszBuf, UINT cchBuf );
 167 #define  StrFormatByteSize WINELIB_NAME_AW(StrFormatByteSize)
 168
 169 DWORD WINAPI PathCleanupSpecA(LPSTR x, LPSTR y);
 170 DWORD WINAPI PathCleanupSpecW(LPWSTR x, LPWSTR y);
 171 #define  PathCleanupSpec WINELIB_NAME_AW(PathCleanupSpec)
 172
 173 /****************************************************************************
 174 *  other functions
 175 */
 176
 177 LPVOID WINAPI SHAlloc(DWORD len);
 178 DWORD WINAPI SHFree(LPVOID x);
 179
 180 #define CSIDL_DESKTOP           0x0000
 181 #define CSIDL_PROGRAMS          0x0002
 182 #define CSIDL_CONTROLS          0x0003
 183 #define CSIDL_PRINTERS          0x0004
 184 #define CSIDL_PERSONAL          0x0005
 185 #define CSIDL_FAVORITES         0x0006
 186 #define CSIDL_STARTUP           0x0007
 187 #define CSIDL_RECENT            0x0008
 188 #define CSIDL_SENDTO            0x0009
 189 #define CSIDL_BITBUCKET         0x000a
 190 #define CSIDL_STARTMENU         0x000b
 191 #define CSIDL_DESKTOPDIRECTORY  0x0010
 192 #define CSIDL_DRIVES            0x0011
 193 #define CSIDL_NETWORK           0x0012
 194 #define CSIDL_NETHOOD           0x0013
 195 #define CSIDL_FONTS             0x0014
 196 #define CSIDL_TEMPLATES         0x0015
 197 #define CSIDL_COMMON_STARTMENU  0x0016
 198 #define CSIDL_COMMON_PROGRAMS   0X0017
 199 #define CSIDL_COMMON_STARTUP    0x0018
 200 #define CSIDL_COMMON_DESKTOPDIRECTORY   0x0019
 201 #define CSIDL_APPDATA           0x001a
 202 #define CSIDL_PRINTHOOD         0x001b
 203 #define CSIDL_ALTSTARTUP        0x001d
 204 #define CSIDL_COMMON_ALTSTARTUP 0x001e
 205 #define CSIDL_COMMON_FAVORITES  0x001f
 206 #define CSIDL_INTERNET_CACHE    0x0020
 207 #define CSIDL_COOKIES           0x0021
 208 #define CSIDL_HISTORY           0x0022
 209
 210 #ifdef __cplusplus
 211 } /* extern "C" */
 212 #endif /* defined(__cplusplus) */
 213
 214 #endif  /* __WINE_SHELL_H */