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