include/ole32/obj_shellfolder.h

   1 /*
   2  * Defines the COM interfaces and APIs related to IShellFolder
   3  *
   4  * Depends on 'obj_base.h'.
   5  */
   6
   7 #ifndef __WINE_WINE_OBJ_SHELLFOLDER_H
   8 #define __WINE_WINE_OBJ_SHELLFOLDER_H
   9
  10 #ifdef __cplusplus
  11 extern "C" {
  12 #endif /* defined(__cplusplus) */
  13
  14 /****************************************************************************
  15 *  STRRET
  16 */
  17 #define STRRET_WSTR     0x0000
  18 #define STRRET_ASTR     0x0003
  19
  20 #define STRRET_OFFSETA  0x0001
  21 #define STRRET_OFFSETW  0x0004
  22 #define STRRET_OFFSET WINELIB_NAME_AW(STRRET_OFFSET)
  23
  24 #define STRRET_CSTRA    0x0002
  25 #define STRRET_CSTRW    0x0005
  26 #define STRRET_CSTR WINELIB_NAME_AW(STRRET_CSTR)
  27
  28 typedef struct _STRRET
  29 { UINT uType;           /* STRRET_xxx */
  30   union
  31   { LPWSTR      pOleStr;        /* OLESTR that will be freed */
  32     LPSTR       pStr;
  33     UINT        uOffset;        /* OffsetINT32o SHITEMID (ANSI) */
  34     char        cStr[MAX_PATH]; /* Buffer to fill in */
  35     WCHAR       cStrW[MAX_PATH];
  36   } DUMMYUNIONNAME;
  37 } STRRET,*LPSTRRET;
  38
  39 /*****************************************************************************
  40  * Predeclare the interfaces
  41  */
  42 typedef struct IShellFolder IShellFolder, *LPSHELLFOLDER;
  43
  44 typedef struct IPersistFolder IPersistFolder, *LPPERSISTFOLDER;
  45
  46 DEFINE_GUID(IID_IPersistFolder2, 0x1ac3d9f0L, 0x175C, 0x11D1, 0x95, 0xBE, 0x00, 0x60, 0x97, 0x97, 0xEA, 0x4F);
  47 typedef struct IPersistFolder2 IPersistFolder2, *LPPERSISTFOLDER2;
  48
  49 DEFINE_GUID(IID_IShellFolder2,  0xB82C5AA8, 0xA41B, 0x11D2, 0xBE, 0x32, 0x0, 0xc0, 0x4F, 0xB9, 0x36, 0x61);
  50 typedef struct IShellFolder2 IShellFolder2, *LPSHELLFOLDER2;
  51
  52 DEFINE_GUID(IID_IEnumExtraSearch,  0xE700BE1, 0x9DB6, 0x11D1, 0xA1, 0xCE, 0x0, 0xc0, 0x4F, 0xD7, 0x5D, 0x13);
  53 typedef struct IEnumExtraSearch IEnumExtraSearch, *LPENUMEXTRASEARCH;
  54
  55 /*****************************************************************************
  56  * IEnumExtraSearch interface
  57  */
  58
  59 typedef struct
  60 {
  61   GUID  guidSearch;
  62   WCHAR wszFriendlyName[80];
  63   WCHAR wszMenuText[80];
  64   WCHAR wszHelpText[MAX_PATH];
  65   WCHAR wszUrl[2084];
  66   WCHAR wszIcon[MAX_PATH+10];
  67   WCHAR wszGreyIcon[MAX_PATH+10];
  68   WCHAR wszClrIcon[MAX_PATH+10];
  69 } EXTRASEARCH,* LPEXTRASEARCH;
  70
  71 #define ICOM_INTERFACE IEnumExtraSearch
  72 #define IEnumExtraSearch_METHODS \
  73     ICOM_METHOD3(HRESULT, Next, ULONG, celt, LPEXTRASEARCH*, rgelt, ULONG*, pceltFetched) \
  74     ICOM_METHOD1(HRESULT, Skip, ULONG, celt) \
  75     ICOM_METHOD (HRESULT, Reset) \
  76     ICOM_METHOD1(HRESULT, Clone, IEnumExtraSearch**, ppenum)
  77 #define IEnumExtraSearch_IMETHODS \
  78     IUnknown_IMETHODS \
  79     IEnumExtraSearch_METHODS
  80 ICOM_DEFINE(IEnumExtraSearch,IUnknown)
  81 #undef ICOM_INTERFACE
  82
  83 /*** IUnknown methods ***/
  84 #define IEnumIDList_QueryInterface(p,a,b)       ICOM_CALL2(QueryInterface,p,a,b)
  85 #define IEnumIDList_AddRef(p)                   ICOM_CALL (AddRef,p)
  86 #define IEnumIDList_Release(p)                  ICOM_CALL (Release,p)
  87 /*** IEnumIDList methods ***/
  88 #define IEnumIDList_Next(p,a,b,c)               ICOM_CALL3(Next,p,a,b,c)
  89 #define IEnumIDList_Skip(p,a)                   ICOM_CALL1(Skip,p,a)
  90 #define IEnumIDList_Reset(p)                    ICOM_CALL(Reset,p)
  91 #define IEnumIDList_Clone(p,a)                  ICOM_CALL1(Clone,p,a)
  92
  93 /*****************************************************************************
  94  * IShellFolder::GetDisplayNameOf/SetNameOf uFlags
  95  */
  96 typedef enum
  97 {       SHGDN_NORMAL            = 0,            /* default (display purpose) */
  98         SHGDN_INFOLDER          = 1,            /* displayed under a folder (relative)*/
  99         SHGDN_FORPARSING        = 0x8000        /* for ParseDisplayName or path */
 100 } SHGNO;
 101
 102 typedef DWORD SHGDNF;
 103
 104 /*****************************************************************************
 105  * IShellFolder::EnumObjects
 106  */
 107 typedef enum tagSHCONTF
 108 {       SHCONTF_FOLDERS         = 32,   /* for shell browser */
 109         SHCONTF_NONFOLDERS      = 64,   /* for default view */
 110         SHCONTF_INCLUDEHIDDEN   = 128   /* for hidden/system objects */
 111     SHCONTF_INIT_ON_FIRST_NEXT = 256,   /* allow EnumObject() to return before validating enum */
 112     SHCONTF_NETPRINTERSRCH  = 512,   /* hint that client is looking for printers */
 113     SHCONTF_SHAREABLE       = 1024,   /* hint that client is looking sharable resources (remote shares) */
 114     SHCONTF_STORAGE                     = 2048   /* include all items with accessible storage and their ancestors */
 115 } SHCONTF;
 116
 117 /*****************************************************************************
 118  * IShellFolder::GetAttributesOf flags
 119  */
 120 #define SFGAO_CANCOPY           DROPEFFECT_COPY /* Objects can be copied */
 121 #define SFGAO_CANMOVE           DROPEFFECT_MOVE /* Objects can be moved */
 122 #define SFGAO_CANLINK           DROPEFFECT_LINK /* Objects can be linked */
 123 #define SFGAO_CANRENAME         0x00000010L     /* Objects can be renamed */
 124 #define SFGAO_CANDELETE         0x00000020L     /* Objects can be deleted */
 125 #define SFGAO_HASPROPSHEET      0x00000040L     /* Objects have property sheets */
 126 #define SFGAO_DROPTARGET        0x00000100L     /* Objects are drop target */
 127 #define SFGAO_CAPABILITYMASK    0x00000177L
 128 #define SFGAO_LINK              0x00010000L     /* Shortcut (link) */
 129 #define SFGAO_SHARE             0x00020000L     /* shared */
 130 #define SFGAO_READONLY          0x00040000L     /* read-only */
 131 #define SFGAO_GHOSTED           0x00080000L     /* ghosted icon */
 132 #define SFGAO_HIDDEN            0x00080000L     /* hidden object */
 133 #define SFGAO_DISPLAYATTRMASK   0x000F0000L
 134 #define SFGAO_FILESYSANCESTOR   0x10000000L     /* It contains file system folder */
 135 #define SFGAO_FOLDER            0x20000000L     /* It's a folder. */
 136 #define SFGAO_FILESYSTEM        0x40000000L     /* is a file system thing (file/folder/root) */
 137 #define SFGAO_HASSUBFOLDER      0x80000000L     /* Expandable in the map pane */
 138 #define SFGAO_CONTENTSMASK      0x80000000L
 139 #define SFGAO_VALIDATE          0x01000000L     /* invalidate cached information */
 140 #define SFGAO_REMOVABLE         0x02000000L     /* is this removeable media? */
 141 #define SFGAO_BROWSABLE         0x08000000L     /* is in-place browsable */
 142 #define SFGAO_NONENUMERATED     0x00100000L     /* is a non-enumerated object */
 143 #define SFGAO_NEWCONTENT        0x00200000L     /* should show bold in explorer tree */
 144 #define SFGAO_COMPRESSED    0x04000000L /* Object is compressed (use alt color) */
 145
 146 typedef ULONG SFGAOF;
 147
 148 /************************************************************************
 149  *
 150  * FOLDERSETTINGS
 151 */
 152
 153 typedef LPBYTE LPVIEWSETTINGS;
 154
 155 /* NB Bitfields. */
 156 /* FWF_DESKTOP implies FWF_TRANSPARENT/NOCLIENTEDGE/NOSCROLL */
 157 typedef enum
 158 { FWF_AUTOARRANGE =       0x0001,
 159   FWF_ABBREVIATEDNAMES =  0x0002,
 160   FWF_SNAPTOGRID =        0x0004,
 161   FWF_OWNERDATA =         0x0008,
 162   FWF_BESTFITWINDOW =     0x0010,
 163   FWF_DESKTOP =           0x0020,
 164   FWF_SINGLESEL =         0x0040,
 165   FWF_NOSUBFOLDERS =      0x0080,
 166   FWF_TRANSPARENT  =      0x0100,
 167   FWF_NOCLIENTEDGE =      0x0200,
 168   FWF_NOSCROLL     =      0x0400,
 169   FWF_ALIGNLEFT    =      0x0800,
 170   FWF_SINGLECLICKACTIVATE=0x8000  /* TEMPORARY -- NO UI FOR THIS */
 171 } FOLDERFLAGS;
 172
 173 typedef enum
 174 { FVM_ICON =              1,
 175   FVM_SMALLICON =         2,
 176   FVM_LIST =              3,
 177   FVM_DETAILS =           4
 178 } FOLDERVIEWMODE;
 179
 180 typedef struct
 181 { UINT ViewMode;       /* View mode (FOLDERVIEWMODE values) */
 182   UINT fFlags;         /* View options (FOLDERFLAGS bits) */
 183 } FOLDERSETTINGS, *LPFOLDERSETTINGS;
 184
 185 typedef const FOLDERSETTINGS * LPCFOLDERSETTINGS;
 186
 187 /************************************************************************
 188  * Desktopfolder
 189  */
 190
 191 extern IShellFolder * pdesktopfolder;
 192
 193 DWORD WINAPI SHGetDesktopFolder(IShellFolder * *);
 194
 195 /*****************************************************************************
 196  * IShellFolder interface
 197  */
 198 #define ICOM_INTERFACE IShellFolder
 199 #define IShellFolder_METHODS \
 200     ICOM_METHOD6( HRESULT, ParseDisplayName, HWND, hwndOwner,LPBC, pbcReserved, LPOLESTR, lpszDisplayName, ULONG *, pchEaten, LPITEMIDLIST *, ppidl, ULONG *, pdwAttributes) \
 201     ICOM_METHOD3( HRESULT, EnumObjects, HWND, hwndOwner, DWORD, grfFlags, LPENUMIDLIST *, ppenumIDList)\
 202     ICOM_METHOD4( HRESULT, BindToObject, LPCITEMIDLIST, pidl, LPBC, pbcReserved, REFIID, riid, LPVOID *, ppvOut)\
 203     ICOM_METHOD4( HRESULT, BindToStorage, LPCITEMIDLIST, pidl, LPBC, pbcReserved, REFIID, riid, LPVOID *, ppvObj)\
 204     ICOM_METHOD3( HRESULT, CompareIDs, LPARAM, lParam, LPCITEMIDLIST, pidl1, LPCITEMIDLIST, pidl2)\
 205     ICOM_METHOD3( HRESULT, CreateViewObject, HWND, hwndOwner, REFIID, riid, LPVOID *, ppvOut)\
 206     ICOM_METHOD3( HRESULT, GetAttributesOf, UINT, cidl, LPCITEMIDLIST *, apidl, ULONG *, rgfInOut)\
 207     ICOM_METHOD6( HRESULT, GetUIObjectOf, HWND, hwndOwner, UINT, cidl, LPCITEMIDLIST *, apidl, REFIID, riid, UINT *, prgfInOut, LPVOID *, ppvOut)\
 208     ICOM_METHOD3( HRESULT, GetDisplayNameOf, LPCITEMIDLIST, pidl, DWORD, uFlags, LPSTRRET, lpName)\
 209     ICOM_METHOD5( HRESULT, SetNameOf, HWND, hwndOwner, LPCITEMIDLIST, pidl,LPCOLESTR, lpszName, DWORD, uFlags,LPITEMIDLIST *, ppidlOut)
 210 #define IShellFolder_IMETHODS \
 211     IUnknown_IMETHODS \
 212     IShellFolder_METHODS
 213 ICOM_DEFINE(IShellFolder,IUnknown)
 214 #undef ICOM_INTERFACE
 215
 216 /*** IUnknown methods ***/
 217 #define IShellFolder_QueryInterface(p,a,b)              ICOM_CALL2(QueryInterface,p,a,b)
 218 #define IShellFolder_AddRef(p)                          ICOM_CALL (AddRef,p)
 219 #define IShellFolder_Release(p)                         ICOM_CALL (Release,p)
 220 /*** IShellFolder methods ***/
 221 #define IShellFolder_ParseDisplayName(p,a,b,c,d,e,f)    ICOM_CALL6(ParseDisplayName,p,a,b,c,d,e,f)
 222 #define IShellFolder_EnumObjects(p,a,b,c)               ICOM_CALL3(EnumObjects,p,a,b,c)
 223 #define IShellFolder_BindToObject(p,a,b,c,d)            ICOM_CALL4(BindToObject,p,a,b,c,d)
 224 #define IShellFolder_BindToStorage(p,a,b,c,d)           ICOM_CALL4(BindToStorage,p,a,b,c,d)
 225 #define IShellFolder_CompareIDs(p,a,b,c)                ICOM_CALL3(CompareIDs,p,a,b,c)
 226 #define IShellFolder_CreateViewObject(p,a,b,c)          ICOM_CALL3(CreateViewObject,p,a,b,c)
 227 #define IShellFolder_GetAttributesOf(p,a,b,c)           ICOM_CALL3(GetAttributesOf,p,a,b,c)
 228 #define IShellFolder_GetUIObjectOf(p,a,b,c,d,e,f)       ICOM_CALL6(GetUIObjectOf,p,a,b,c,d,e,f)
 229 #define IShellFolder_GetDisplayNameOf(p,a,b,c)          ICOM_CALL3(GetDisplayNameOf,p,a,b,c)
 230 #define IShellFolder_SetNameOf(p,a,b,c,d,e)             ICOM_CALL5(SetNameOf,p,a,b,c,d,e)
 231
 232 /*****************************************************************************
 233  * IShellFolder2 interface
 234  */
 235 /* IShellFolder2 */
 236
 237 /* GetDefaultColumnState */
 238 typedef enum
 239 {
 240         SHCOLSTATE_TYPE_STR     = 0x00000001,
 241         SHCOLSTATE_TYPE_INT     = 0x00000002,
 242         SHCOLSTATE_TYPE_DATE    = 0x00000003,
 243         SHCOLSTATE_TYPEMASK     = 0x0000000F,
 244         SHCOLSTATE_ONBYDEFAULT  = 0x00000010,
 245         SHCOLSTATE_SLOW         = 0x00000020,
 246         SHCOLSTATE_EXTENDED     = 0x00000040,
 247         SHCOLSTATE_SECONDARYUI  = 0x00000080,
 248         SHCOLSTATE_HIDDEN       = 0x00000100,
 249 } SHCOLSTATE;
 250
 251 typedef struct
 252 {
 253         GUID    fmtid;
 254         DWORD   pid;
 255 } SHCOLUMNID, *LPSHCOLUMNID;
 256 typedef const SHCOLUMNID* LPCSHCOLUMNID;
 257
 258 /* GetDetailsEx */
 259 #define PID_FINDDATA            0
 260 #define PID_NETRESOURCE         1
 261 #define PID_DESCRIPTIONID       2
 262
 263 typedef struct
 264 {
 265         int     fmt;
 266         int     cxChar;
 267         STRRET  str;
 268 } SHELLDETAILS, *LPSHELLDETAILS;
 269
 270 #define ICOM_INTERFACE IShellFolder2
 271 #define IShellFolder2_METHODS \
 272     ICOM_METHOD1( HRESULT, GetDefaultSearchGUID, LPGUID, lpguid)\
 273     ICOM_METHOD1( HRESULT, EnumSearches, LPENUMEXTRASEARCH *, ppEnum) \
 274     ICOM_METHOD3( HRESULT, GetDefaultColumn, DWORD, dwReserved, ULONG *, pSort, ULONG *, pDisplay)\
 275     ICOM_METHOD2( HRESULT, GetDefaultColumnState, UINT, iColumn, DWORD *, pcsFlags)\
 276     ICOM_METHOD3( HRESULT, GetDetailsEx, LPCITEMIDLIST, pidl, const SHCOLUMNID *, pscid, VARIANT *, pv)\
 277     ICOM_METHOD3( HRESULT, GetDetailsOf, LPCITEMIDLIST, pidl, UINT, iColumn, LPSHELLDETAILS, pDetails)\
 278     ICOM_METHOD2( HRESULT, MapNameToSCID, LPCWSTR, pwszName, SHCOLUMNID *, pscid)
 279 #define IShellFolder2_IMETHODS \
 280     IShellFolder_METHODS \
 281     IShellFolder2_METHODS
 282 ICOM_DEFINE(IShellFolder2, IShellFolder)
 283 #undef ICOM_INTERFACE
 284
 285 /*** IUnknown methods ***/
 286 #define IShellFolder2_QueryInterface(p,a,b)             ICOM_CALL2(QueryInterface,p,a,b)
 287 #define IShellFolder2_AddRef(p)                         ICOM_CALL (AddRef,p)
 288 #define IShellFolder2_Release(p)                        ICOM_CALL (Release,p)
 289 /*** IShellFolder methods ***/
 290 #define IShellFolder2_ParseDisplayName(p,a,b,c,d,e,f)   ICOM_CALL6(ParseDisplayName,p,a,b,c,d,e,f)
 291 #define IShellFolder2_EnumObjects(p,a,b,c)              ICOM_CALL3(EnumObjects,p,a,b,c)
 292 #define IShellFolder2_BindToObject(p,a,b,c,d)           ICOM_CALL4(BindToObject,p,a,b,c,d)
 293 #define IShellFolder2_BindToStorage(p,a,b,c,d)          ICOM_CALL4(BindToStorage,p,a,b,c,d)
 294 #define IShellFolder2_CompareIDs(p,a,b,c)               ICOM_CALL3(CompareIDs,p,a,b,c)
 295 #define IShellFolder2_CreateViewObject(p,a,b,c)         ICOM_CALL3(CreateViewObject,p,a,b,c)
 296 #define IShellFolder2_GetAttributesOf(p,a,b,c)          ICOM_CALL3(GetAttributesOf,p,a,b,c)
 297 #define IShellFolder2_GetUIObjectOf(p,a,b,c,d,e,f)      ICOM_CALL6(GetUIObjectOf,p,a,b,c,d,e,f)
 298 #define IShellFolder2_GetDisplayNameOf(p,a,b,c)         ICOM_CALL3(GetDisplayNameOf,p,a,b,c)
 299 #define IShellFolder2_SetNameOf(p,a,b,c,d,e)            ICOM_CALL5(SetNameOf,p,a,b,c,d,e)
 300 /*** IShellFolder2 methods ***/
 301 #define IShellFolder2_GetDefaultSearchGUID(p,a)         ICOM_CALL1(GetDefaultSearchGUID,p,a)
 302 #define IShellFolder2_EnumSearches(p,a)                 ICOM_CALL1(EnumSearches,p,a)
 303 #define IShellFolder2_GetDefaultColumn(p,a,b,c)         ICOM_CALL3(GetDefaultColumn,p,a,b,c)
 304 #define IShellFolder2_GetDefaultColumnState(p,a,b)      ICOM_CALL2(GetDefaultColumnState,p,a,b)
 305 #define IShellFolder2_GetDetailsEx(p,a,b,c)             ICOM_CALL3(GetDetailsEx,p,a,b,c)
 306 #define IShellFolder2_GetDetailsOf(p,a,b,c)             ICOM_CALL3(GetDetailsOf,p,a,b,c)
 307 #define IShellFolder2_MapNameToSCID(p,a,b)              ICOM_CALL2(MapNameToSCID,p,a,b)
 308
 309 /*****************************************************************************
 310  * IPersistFolder interface
 311  */
 312
 313 /* ClassID's */
 314 DEFINE_GUID (CLSID_SFMyComp,0x20D04FE0,0x3AEA,0x1069,0xA2,0xD8,0x08,0x00,0x2B,0x30,0x30,0x9D);
 315 DEFINE_GUID (CLSID_SFINet,  0x871C5380,0x42A0,0x1069,0xA2,0xEA,0x08,0x00,0x2B,0x30,0x30,0x9D);
 316 DEFINE_GUID (CLSID_SFFile,  0xF3364BA0,0x65B9,0x11CE,0xA9,0xBA,0x00,0xAA,0x00,0x4A,0xE8,0x37);
 317
 318 #define ICOM_INTERFACE IPersistFolder
 319 #define IPersistFolder_METHODS \
 320     ICOM_METHOD1( HRESULT, Initialize, LPCITEMIDLIST, pidl)
 321 #define IPersistFolder_IMETHODS \
 322     IPersist_IMETHODS \
 323     IPersistFolder_METHODS
 324 ICOM_DEFINE(IPersistFolder, IPersist)
 325 #undef ICOM_INTERFACE
 326
 327 /*** IUnknown methods ***/
 328 #define IPersistFolder_QueryInterface(p,a,b)    ICOM_CALL2(QueryInterface,p,a,b)
 329 #define IPersistFolder_AddRef(p)                ICOM_CALL (AddRef,p)
 330 #define IPersistFolder_Release(p)               ICOM_CALL (Release,p)
 331 /*** IPersist methods ***/
 332 #define IPersistFolder_GetClassID(p,a)          ICOM_CALL1(GetClassID,p,a)
 333 /*** IPersistFolder methods ***/
 334 #define IPersistFolder_Initialize(p,a)          ICOM_CALL1(Initialize,p,a)
 335
 336 /*****************************************************************************
 337  * IPersistFolder2 interface
 338  */
 339
 340 #define ICOM_INTERFACE IPersistFolder2
 341 #define IPersistFolder2_METHODS \
 342     ICOM_METHOD1( HRESULT, GetCurFolder, LPITEMIDLIST*, pidl)
 343 #define IPersistFolder2_IMETHODS \
 344     IPersist_IMETHODS \
 345     IPersistFolder_METHODS \
 346     IPersistFolder2_METHODS
 347 ICOM_DEFINE(IPersistFolder2, IPersistFolder)
 348 #undef ICOM_INTERFACE
 349
 350 /*** IUnknown methods ***/
 351 #define IPersistFolder2_QueryInterface(p,a,b)   ICOM_CALL2(QueryInterface,p,a,b)
 352 #define IPersistFolder2_AddRef(p)               ICOM_CALL (AddRef,p)
 353 #define IPersistFolder2_Release(p)              ICOM_CALL (Release,p)
 354 /*** IPersist methods ***/
 355 #define IPersistFolder2_GetClassID(p,a)         ICOM_CALL1(GetClassID,p,a)
 356 /*** IPersistFolder methods ***/
 357 #define IPersistFolder2_Initialize(p,a)         ICOM_CALL1(Initialize,p,a)
 358 /*** IPersistFolder2 methods ***/
 359 #define IPersistFolder2_GetCurFolder(p,a)       ICOM_CALL1(GetCurFolder,p,a)
 360
 361 #ifdef __cplusplus
 362 } /* extern "C" */
 363 #endif /* defined(__cplusplus) */
 364
 365 #endif /* __WINE_WINE_OBJ_SHELLFOLDER_H */