Added IPersistPropertyBag2 and IPropertyBag2 definitions, added
[wine] / include / wine / obj_shellview.h
1 /************************************************************
2  *    IShellView
3  */
4
5 #ifndef __WINE_WINE_OBJ_SHELLVIEW_H
6 #define __WINE_WINE_OBJ_SHELLVIEW_H
7
8 #ifdef __cplusplus
9 extern "C" {
10 #endif /* defined(__cplusplus) */
11
12 /****************************************************************************
13  * IShellBrowser is here defined because of a cyclic dependance between 
14  * IShellBrowser and IShellView
15  */
16 typedef struct IShellBrowser IShellBrowser, *LPSHELLBROWSER;
17
18 typedef struct IShellView IShellView, *LPSHELLVIEW;
19
20 /* shellview select item flags*/
21 #define SVSI_DESELECT   0x0000
22 #define SVSI_SELECT     0x0001
23 #define SVSI_EDIT       0x0003  /* includes select */
24 #define SVSI_DESELECTOTHERS 0x0004
25 #define SVSI_ENSUREVISIBLE  0x0008
26 #define SVSI_FOCUSED        0x0010
27
28 /* shellview get item object flags */
29 #define SVGIO_BACKGROUND    0x00000000
30 #define SVGIO_SELECTION     0x00000001
31 #define SVGIO_ALLVIEW       0x00000002
32
33 /* The explorer dispatches WM_COMMAND messages based on the range of
34  command/menuitem IDs. All the IDs of menuitems that the view (right
35  pane) inserts must be in FCIDM_SHVIEWFIRST/LAST (otherwise, the explorer
36  won't dispatch them). The view should not deal with any menuitems
37  in FCIDM_BROWSERFIRST/LAST (otherwise, it won't work with the future
38  version of the shell).
39
40   FCIDM_SHVIEWFIRST/LAST      for the right pane (IShellView)
41   FCIDM_BROWSERFIRST/LAST     for the explorer frame (IShellBrowser)
42   FCIDM_GLOBAL/LAST           for the explorer's submenu IDs
43 */
44 #define FCIDM_SHVIEWFIRST       0x0000
45 /* undocumented */
46 #define FCIDM_SHVIEW_ARRANGE    0x7001
47 #define FCIDM_SHVIEW_DELETE     0x7011
48 #define FCIDM_SHVIEW_PROPERTIES 0x7013
49 #define FCIDM_SHVIEW_CUT        0x7018
50 #define FCIDM_SHVIEW_COPY       0x7019
51 #define FCIDM_SHVIEW_INSERT     0x701A
52 #define FCIDM_SHVIEW_UNDO       0x701B
53 #define FCIDM_SHVIEW_INSERTLINK 0x701C
54 #define FCIDM_SHVIEW_SELECTALL  0x7021
55 #define FCIDM_SHVIEW_INVERTSELECTION 0x7022
56
57 #define FCIDM_SHVIEW_BIGICON    0x7029
58 #define FCIDM_SHVIEW_SMALLICON  0x702A
59 #define FCIDM_SHVIEW_LISTVIEW   0x702B  
60 #define FCIDM_SHVIEW_REPORTVIEW 0x702C
61 /* 0x7030-0x703f are used by the shellbrowser */
62 #define FCIDM_SHVIEW_AUTOARRANGE 0x7031  
63 #define FCIDM_SHVIEW_SNAPTOGRID 0x7032
64
65 #define FCIDM_SHVIEW_HELP       0x7041
66 #define FCIDM_SHVIEW_RENAME     0x7050
67 #define FCIDM_SHVIEW_CREATELINK 0x7051
68 #define FCIDM_SHVIEW_NEWLINK    0x7052
69 #define FCIDM_SHVIEW_NEWFOLDER  0x7053
70
71 #define FCIDM_SHVIEW_REFRESH    0x7100 /* fixme */
72 #define FCIDM_SHVIEW_EXPLORE    0x7101 /* fixme */
73 #define FCIDM_SHVIEW_OPEN       0x7102 /* fixme */
74
75 #define FCIDM_SHVIEWLAST        0x7fff
76 #define FCIDM_BROWSERFIRST      0xA000
77 /* undocumented toolbar items from stddlg's*/
78 #define FCIDM_TB_UPFOLDER       0xA001
79 #define FCIDM_TB_NEWFOLDER      0xA002
80 #define FCIDM_TB_SMALLICON      0xA003
81 #define FCIDM_TB_REPORTVIEW     0xA004
82 #define FCIDM_TB_DESKTOP        0xA005  /* fixme */
83
84 #define FCIDM_BROWSERLAST       0xbf00
85 #define FCIDM_GLOBALFIRST       0x8000
86 #define FCIDM_GLOBALLAST        0x9fff
87
88 /*
89 * Global submenu IDs and separator IDs
90 */
91 #define FCIDM_MENU_FILE             (FCIDM_GLOBALFIRST+0x0000)
92 #define FCIDM_MENU_EDIT             (FCIDM_GLOBALFIRST+0x0040)
93 #define FCIDM_MENU_VIEW             (FCIDM_GLOBALFIRST+0x0080)
94 #define FCIDM_MENU_VIEW_SEP_OPTIONS (FCIDM_GLOBALFIRST+0x0081)
95 #define FCIDM_MENU_TOOLS            (FCIDM_GLOBALFIRST+0x00c0)
96 #define FCIDM_MENU_TOOLS_SEP_GOTO   (FCIDM_GLOBALFIRST+0x00c1)
97 #define FCIDM_MENU_HELP             (FCIDM_GLOBALFIRST+0x0100)
98 #define FCIDM_MENU_FIND             (FCIDM_GLOBALFIRST+0x0140)
99 #define FCIDM_MENU_EXPLORE          (FCIDM_GLOBALFIRST+0x0150)
100 #define FCIDM_MENU_FAVORITES        (FCIDM_GLOBALFIRST+0x0170)
101
102 /* control IDs known to the view */
103 #define FCIDM_TOOLBAR      (FCIDM_BROWSERFIRST + 0)
104 #define FCIDM_STATUS       (FCIDM_BROWSERFIRST + 1)
105
106 /* uState values for IShellView::UIActivate */
107 typedef enum 
108 { SVUIA_DEACTIVATE       = 0,
109   SVUIA_ACTIVATE_NOFOCUS = 1,
110   SVUIA_ACTIVATE_FOCUS   = 2,
111   SVUIA_INPLACEACTIVATE  = 3          /* new flag for IShellView2 */
112 } SVUIA_STATUS;
113
114 #define ICOM_INTERFACE IShellView
115 #define IShellView_METHODS \
116         ICOM_METHOD1(HRESULT, TranslateAccelerator, LPMSG, lpmsg) \
117         ICOM_METHOD1(HRESULT, EnableModeless, BOOL, fEnable) \
118         ICOM_METHOD1(HRESULT, UIActivate, UINT, uState) \
119         ICOM_METHOD(HRESULT, Refresh) \
120         ICOM_METHOD5(HRESULT, CreateViewWindow, IShellView*, lpPrevView, LPCFOLDERSETTINGS, lpfs, IShellBrowser*, psb, RECT*, prcView, HWND*, phWnd) \
121         ICOM_METHOD(HRESULT, DestroyViewWindow) \
122         ICOM_METHOD1(HRESULT, GetCurrentInfo, LPFOLDERSETTINGS, lpfs) \
123         ICOM_METHOD3(HRESULT, AddPropertySheetPages, DWORD, dwReserved, LPFNADDPROPSHEETPAGE, lpfn, LPARAM, lparam) \
124         ICOM_METHOD (HRESULT, SaveViewState) \
125         ICOM_METHOD2(HRESULT, SelectItem, LPCITEMIDLIST, pidlItem, UINT, uFlags) \
126         ICOM_METHOD3(HRESULT, GetItemObject, UINT, uItem, REFIID, riid, LPVOID*, ppv) \
127         ICOM_METHOD1(HRESULT, EditItem, LPCITEMIDLIST, pidlItem)
128 #define IShellView_IMETHODS \
129         IOleWindow_IMETHODS \
130         IShellView_METHODS
131 ICOM_DEFINE(IShellView,IOleWindow)
132 #undef ICOM_INTERFACE
133
134 /*** IUnknown methods ***/
135 #define IShellView_QueryInterface(p,a,b)        ICOM_CALL2(QueryInterface,p,a,b)
136 #define IShellView_AddRef(p)                    ICOM_CALL(AddRef,p)
137 #define IShellView_Release(p)                   ICOM_CALL(Release,p)
138 /*** IShellView methods ***/
139 #define IShellView_GetWindow(p,a)               ICOM_CALL1(GetWindow,p,a)
140 #define IShellView_ContextSensitiveHelp(p,a)    ICOM_CALL1(ContextSensitiveHelp,p,a)
141 #define IShellView_TranslateAccelerator(p,a)    ICOM_CALL1(TranslateAccelerator,p,a)
142 #define IShellView_EnableModeless(p,a)          ICOM_CALL1(EnableModeless,p,a)
143 #define IShellView_UIActivate(p,a)              ICOM_CALL1(UIActivate,p,a)
144 #define IShellView_Refresh(p)                   ICOM_CALL(Refresh,p)
145 #define IShellView_CreateViewWindow(p,a,b,c,d,e)        ICOM_CALL5(CreateViewWindow,p,a,b,c,d,e)
146 #define IShellView_DestroyViewWindow(p)         ICOM_CALL(DestroyViewWindow,p)
147 #define IShellView_GetCurrentInfo(p,a)          ICOM_CALL1(GetCurrentInfo,p,a)
148 #define IShellView_AddPropertySheetPages(p,a,b,c)       ICOM_CALL3(AddPropertySheetPages,p,a,b,c)
149 #define IShellView_SaveViewState(p)             ICOM_CALL(SaveViewState,p)
150 #define IShellView_SelectItem(p,a,b)            ICOM_CALL2(SelectItem,p,a,b)
151 #define IShellView_GetItemObject(p,a,b,c)       ICOM_CALL3(GetItemObject,p,a,b,c)
152 /* WINE specific */
153 #define IShellView_EditItem(p,a)                ICOM_CALL1(EditItem,p,a)
154
155 #ifdef __cplusplus
156 } /* extern "C" */
157 #endif /* defined(__cplusplus) */
158
159 #endif /* __WINE_WINE_OBJ_SHELLVIEW_H */