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 "winbase.h"
  14 #include "shell.h"
  15
  16 #ifdef __cplusplus
  17 extern "C" {
  18 #endif /* defined(__cplusplus) */
  19
  20 /****************************************************************************
  21 *  STRRET (temporary, move it away)
  22 */
  23 #define STRRET_WSTR     0x0000
  24 #define STRRET_OFFSETA  0x0001
  25 #define STRRET_CSTRA    0x0002
  26 #define STRRET_ASTR     0X0003
  27 #define STRRET_OFFSETW  0X0004
  28 #define STRRET_CSTRW    0X0005
  29
  30
  31 typedef struct _STRRET
  32 { UINT uType;           /* STRRET_xxx */
  33   union
  34   { LPWSTR      pOleStr;        /* OLESTR that will be freed */
  35     LPSTR       pStr;
  36     UINT        uOffset;        /* OffsetINT32o SHITEMID (ANSI) */
  37     char        cStr[MAX_PATH]; /* Buffer to fill in */
  38     WCHAR       cStrW[MAX_PATH];
  39   }u;
  40 } STRRET,*LPSTRRET;
  41
  42 /*****************************************************************************
  43  * Predeclare the interfaces
  44  */
  45 DEFINE_SHLGUID(IID_IShellFolder,        0x000214E6L, 0, 0);
  46 typedef struct IShellFolder IShellFolder, *LPSHELLFOLDER;
  47
  48 DEFINE_SHLGUID(IID_IPersistFolder,      0x000214EAL, 0, 0);
  49 typedef struct IPersistFolder IPersistFolder, *LPPERSISTFOLDER;
  50
  51
  52 /*****************************************************************************
  53  * IShellFolder::GetDisplayNameOf/SetNameOf uFlags
  54  */
  55 typedef enum
  56 {       SHGDN_NORMAL            = 0,            /* default (display purpose) */
  57         SHGDN_INFOLDER          = 1,            /* displayed under a folder (relative)*/
  58         SHGDN_FORPARSING        = 0x8000        /* for ParseDisplayName or path */
  59 } SHGNO;
  60
  61 /*****************************************************************************
  62  * IShellFolder::EnumObjects
  63  */
  64 typedef enum tagSHCONTF
  65 {       SHCONTF_FOLDERS         = 32,   /* for shell browser */
  66         SHCONTF_NONFOLDERS      = 64,   /* for default view */
  67         SHCONTF_INCLUDEHIDDEN   = 128   /* for hidden/system objects */
  68 } SHCONTF;
  69
  70 /*****************************************************************************
  71  * IShellFolder::GetAttributesOf flags
  72  */
  73 #define SFGAO_CANCOPY           DROPEFFECT_COPY /* Objects can be copied */
  74 #define SFGAO_CANMOVE           DROPEFFECT_MOVE /* Objects can be moved */
  75 #define SFGAO_CANLINK           DROPEFFECT_LINK /* Objects can be linked */
  76 #define SFGAO_CANRENAME         0x00000010L     /* Objects can be renamed */
  77 #define SFGAO_CANDELETE         0x00000020L     /* Objects can be deleted */
  78 #define SFGAO_HASPROPSHEET      0x00000040L     /* Objects have property sheets */
  79 #define SFGAO_DROPTARGET        0x00000100L     /* Objects are drop target */
  80 #define SFGAO_CAPABILITYMASK    0x00000177L
  81 #define SFGAO_LINK              0x00010000L     /* Shortcut (link) */
  82 #define SFGAO_SHARE             0x00020000L     /* shared */
  83 #define SFGAO_READONLY          0x00040000L     /* read-only */
  84 #define SFGAO_GHOSTED           0x00080000L     /* ghosted icon */
  85 #define SFGAO_HIDDEN            0x00080000L     /* hidden object */
  86 #define SFGAO_DISPLAYATTRMASK   0x000F0000L
  87 #define SFGAO_FILESYSANCESTOR   0x10000000L     /* It contains file system folder */
  88 #define SFGAO_FOLDER            0x20000000L     /* It's a folder. */
  89 #define SFGAO_FILESYSTEM        0x40000000L     /* is a file system thing (file/folder/root) */
  90 #define SFGAO_HASSUBFOLDER      0x80000000L     /* Expandable in the map pane */
  91 #define SFGAO_CONTENTSMASK      0x80000000L
  92 #define SFGAO_VALIDATE          0x01000000L     /* invalidate cached information */
  93 #define SFGAO_REMOVABLE         0x02000000L     /* is this removeable media? */
  94 #define SFGAO_BROWSABLE         0x08000000L     /* is in-place browsable */
  95 #define SFGAO_NONENUMERATED     0x00100000L     /* is a non-enumerated object */
  96 #define SFGAO_NEWCONTENT        0x00200000L     /* should show bold in explorer tree */
  97
  98 /************************************************************************
  99  *
 100  * FOLDERSETTINGS
 101 */
 102
 103 typedef LPBYTE LPVIEWSETTINGS;
 104
 105 /* NB Bitfields. */
 106 /* FWF_DESKTOP implies FWF_TRANSPARENT/NOCLIENTEDGE/NOSCROLL */
 107 typedef enum
 108 { FWF_AUTOARRANGE =       0x0001,
 109   FWF_ABBREVIATEDNAMES =  0x0002,
 110   FWF_SNAPTOGRID =        0x0004,
 111   FWF_OWNERDATA =         0x0008,
 112   FWF_BESTFITWINDOW =     0x0010,
 113   FWF_DESKTOP =           0x0020,
 114   FWF_SINGLESEL =         0x0040,
 115   FWF_NOSUBFOLDERS =      0x0080,
 116   FWF_TRANSPARENT  =      0x0100,
 117   FWF_NOCLIENTEDGE =      0x0200,
 118   FWF_NOSCROLL     =      0x0400,
 119   FWF_ALIGNLEFT    =      0x0800,
 120   FWF_SINGLECLICKACTIVATE=0x8000  /* TEMPORARY -- NO UI FOR THIS */
 121 } FOLDERFLAGS;
 122
 123 typedef enum
 124 { FVM_ICON =              1,
 125   FVM_SMALLICON =         2,
 126   FVM_LIST =              3,
 127   FVM_DETAILS =           4
 128 } FOLDERVIEWMODE;
 129
 130 typedef struct
 131 { UINT ViewMode;       /* View mode (FOLDERVIEWMODE values) */
 132   UINT fFlags;         /* View options (FOLDERFLAGS bits) */
 133 } FOLDERSETTINGS, *LPFOLDERSETTINGS;
 134
 135 typedef const FOLDERSETTINGS * LPCFOLDERSETTINGS;
 136
 137 /************************************************************************
 138  * Desktopfolder
 139  */
 140
 141 extern IShellFolder * pdesktopfolder;
 142
 143 DWORD WINAPI SHGetDesktopFolder(IShellFolder * *);
 144
 145 /*****************************************************************************
 146  * IShellFolder interface
 147  */
 148 #define ICOM_INTERFACE IShellFolder
 149 #define IShellFolder_METHODS \
 150     ICOM_METHOD6( HRESULT, ParseDisplayName, HWND, hwndOwner,LPBC, pbcReserved, LPOLESTR, lpszDisplayName, ULONG *, pchEaten, LPITEMIDLIST *, ppidl, ULONG *, pdwAttributes) \
 151     ICOM_METHOD3( HRESULT, EnumObjects, HWND, hwndOwner, DWORD, grfFlags, LPENUMIDLIST *, ppenumIDList)\
 152     ICOM_METHOD4( HRESULT, BindToObject, LPCITEMIDLIST, pidl, LPBC, pbcReserved, REFIID, riid, LPVOID *, ppvOut)\
 153     ICOM_METHOD4( HRESULT, BindToStorage, LPCITEMIDLIST, pidl, LPBC, pbcReserved, REFIID, riid, LPVOID *, ppvObj)\
 154     ICOM_METHOD3( HRESULT, CompareIDs, LPARAM, lParam, LPCITEMIDLIST, pidl1, LPCITEMIDLIST, pidl2)\
 155     ICOM_METHOD3( HRESULT, CreateViewObject, HWND, hwndOwner, REFIID, riid, LPVOID *, ppvOut)\
 156     ICOM_METHOD3( HRESULT, GetAttributesOf, UINT, cidl, LPCITEMIDLIST *, apidl, ULONG *, rgfInOut)\
 157     ICOM_METHOD6( HRESULT, GetUIObjectOf, HWND, hwndOwner, UINT, cidl, LPCITEMIDLIST *, apidl, REFIID, riid, UINT *, prgfInOut, LPVOID *, ppvOut)\
 158     ICOM_METHOD3( HRESULT, GetDisplayNameOf, LPCITEMIDLIST, pidl, DWORD, uFlags, LPSTRRET, lpName)\
 159     ICOM_METHOD5( HRESULT, SetNameOf, HWND, hwndOwner, LPCITEMIDLIST, pidl,LPCOLESTR, lpszName, DWORD, uFlags,LPITEMIDLIST *, ppidlOut)\
 160     ICOM_METHOD2( HRESULT, GetFolderPath, LPSTR, lpszOut, DWORD, dwOutSize)
 161 #define IShellFolder_IMETHODS \
 162     IUnknown_IMETHODS \
 163     IShellFolder_METHODS
 164 ICOM_DEFINE(IShellFolder,IUnknown)
 165 #undef ICOM_INTERFACE
 166
 167 #ifdef ICOM_CINTERFACE
 168 /*** IUnknown methods ***/
 169 #define IShellFolder_QueryInterface(p,a,b)              ICOM_CALL2(QueryInterface,p,a,b)
 170 #define IShellFolder_AddRef(p)                          ICOM_CALL (AddRef,p)
 171 #define IShellFolder_Release(p)                         ICOM_CALL (Release,p)
 172 /*** IShellFolder methods ***/
 173 #define IShellFolder_ParseDisplayName(p,a,b,c,d,e,f)    ICOM_CALL6(ParseDisplayName,p,a,b,c,d,e,f)
 174 #define IShellFolder_EnumObjects(p,a,b,c)               ICOM_CALL3(EnumObjects,p,a,b,c)
 175 #define IShellFolder_BindToObject(p,a,b,c,d)            ICOM_CALL4(BindToObject,p,a,b,c,d)
 176 #define IShellFolder_BindToStorage(p,a,b,c,d)           ICOM_CALL4(BindToStorage,p,a,b,c,d)
 177 #define IShellFolder_CompareIDs(p,a,b,c)                ICOM_CALL3(CompareIDs,p,a,b,c)
 178 #define IShellFolder_CreateViewObject(p,a,b,c)          ICOM_CALL3(CreateViewObject,p,a,b,c)
 179 #define IShellFolder_GetAttributesOf(p,a,b,c)           ICOM_CALL3(GetAttributesOf,p,a,b,c)
 180 #define IShellFolder_GetUIObjectOf(p,a,b,c,d,e,f)       ICOM_CALL6(GetUIObjectOf,p,a,b,c,d,e,f)
 181 #define IShellFolder_GetDisplayNameOf(p,a,b,c)          ICOM_CALL3(GetDisplayNameOf,p,a,b,c)
 182 #define IShellFolder_SetNameOf(p,a,b,c,d,e)             ICOM_CALL5(SetNameOf,p,a,b,c,d,e)
 183 #define IShellFolder_GetFolderPath(p,a,b)               ICOM_CALL2(GetFolderPath,p,a,b)
 184 #endif
 185
 186 /*****************************************************************************
 187  * IPersistFolder interface
 188  */
 189
 190 DEFINE_GUID (CLSID_SFMyComp,0x20D04FE0,0x3AEA,0x1069,0xA2,0xD8,0x08,0x00,0x2B,0x30,0x30,0x9D);
 191 DEFINE_GUID (CLSID_SFINet,  0x871C5380,0x42A0,0x1069,0xA2,0xEA,0x08,0x00,0x2B,0x30,0x30,0x9D);
 192 DEFINE_GUID (CLSID_SFFile,  0xF3364BA0,0x65B9,0x11CE,0xA9,0xBA,0x00,0xAA,0x00,0x4A,0xE8,0x37);
 193
 194 #define ICOM_INTERFACE IPersistFolder
 195 #define IPersistFolder_METHODS \
 196     ICOM_METHOD1( HRESULT, Initialize, LPCITEMIDLIST, pidl)
 197 #define IPersistFolder_IMETHODS \
 198     IPersist_IMETHODS \
 199     IPersistFolder_METHODS
 200 ICOM_DEFINE(IPersistFolder, IPersist)
 201 #undef ICOM_INTERFACE
 202
 203 #ifdef ICOM_CINTERFACE
 204 /*** IUnknown methods ***/
 205 #define IPersistFolder_QueryInterface(p,a,b)    ICOM_CALL2(QueryInterface,p,a,b)
 206 #define IPersistFolder_AddRef(p)                ICOM_CALL (AddRef,p)
 207 #define IPersistFolder_Release(p)               ICOM_CALL (Release,p)
 208 /*** IPersist methods ***/
 209 #define IPersistFolder_GetClassID(p,a)          ICOM_CALL1(GetClassID,p,a)
 210 /*** IPersistFolder methods ***/
 211 #define IPersistFolder_Initialize(p,a)          ICOM_CALL1(Initialize,p,a)
 212 #endif
 213
 214 #ifdef __cplusplus
 215 } /* extern "C" */
 216 #endif /* defined(__cplusplus) */
 217
 218 #endif /* __WINE_WINE_OBJ_SHELLLINK_H */