ddraw/tests: Add readback tests to test_palette_gdi.
[wine.git] / include / shldisp.idl
blob56be77833c1410af7c5991ebc9438efeb7dc5605
1 /*
2 * COM interfaces for shell objects
4 * Copyright (C) 2004 Maxime Bellengé
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
21 import "ocidl.idl";
23 #include <shdispid.h>
25 cpp_quote("#ifdef WINE_NO_UNICODE_MACROS")
26 cpp_quote("#undef ShellExecute")
27 cpp_quote("#endif")
29 /*****************************************************************************
30 * IEnumACString interface
33 local,
34 object,
35 uuid(8e74c210-cf9d-4eaf-a403-7356428f0a5a),
36 pointer_default(unique)
38 interface IEnumACString : IEnumString
40 typedef IEnumACString *PENUMACSTRING, *LPENUMACSTRING;
42 typedef enum _tagACENUMOPTION
44 ACEO_NONE = 0x00000000,
45 ACEO_MOSTRECENTFIRST = 0x00000001,
46 ACEO_FIRSTUNUSED = 0x00010000,
47 } ACENUMOPTION;
49 HRESULT NextItem( [out] LPWSTR pszUrl,
50 [in] ULONG cchMax,
51 [out] ULONG *pulSortIndex);
53 HRESULT SetEnumOptions( [in] DWORD dwOptions );
55 HRESULT GetEnumOptions( [out] DWORD *pdwOptions );
58 /*****************************************************************************
59 * IAutoComplete interface
62 local,
63 object,
64 uuid(00bb2762-6a77-11d0-a535-00c04fd7d062),
65 pointer_default(unique)
67 interface IAutoComplete : IUnknown
69 typedef IAutoComplete *LPAUTOCOMPLETE;
71 HRESULT Init( [in] HWND hwndEdit,
72 [in] IUnknown *punkACL,
73 [in] LPCOLESTR pwszRegKeyPath,
74 [in] LPCOLESTR pwszQuickComplete);
76 HRESULT Enable( [in] BOOL fEnable );
79 /*****************************************************************************
80 * IAutoComplete2 interface
83 local,
84 object,
85 uuid(eac04bc0-3791-11d2-bb95-0060977b464c),
86 pointer_default(unique)
88 interface IAutoComplete2 : IAutoComplete
90 typedef IAutoComplete2 *LPAUTOCOMPLETE2;
92 typedef enum _tagAUTOCOMPLETEOPTIONS
94 ACO_NONE = 0x00, /* No AutoComplete */
95 ACO_AUTOSUGGEST = 0x01, /* enable autosuggest dropdown */
96 ACO_AUTOAPPEND = 0x02, /* enable autoappend */
97 ACO_SEARCH = 0x04, /* add search entry to completion list */
98 ACO_FILTERPREFIXES = 0x08, /* don't match common prefixes (www., http://, etc) */
99 ACO_USETAB = 0x10, /* use tab to select autosuggest entries */
100 ACO_UPDOWNKEYDROPSLIST = 0x20, /* up/down arrow key invokes autosuggest dropdown (if enabled) */
101 ACO_RTLREADING = 0x40, /* enable RTL reading order for dropdown */
102 } AUTOCOMPLETEOPTIONS;
104 HRESULT SetOptions( [in] DWORD dwFlag);
106 HRESULT GetOptions( [out] DWORD *pdwFlag);
110 uuid(50a7e9b0-70ef-11d1-b75a-00a0c90564fe),
111 version(1.0)
113 library Shell32
116 importlib("stdole2.tlb");
119 object,
120 oleautomation,
121 uuid(9ba05970-f6a8-11cf-a442-00a0c90a8f39),
122 pointer_default(unique)
124 interface IFolderViewOC : IDispatch
126 HRESULT SetFolderView( [in] IDispatch *pdisp );
130 uuid(62112aa2-ebe4-11cf-a5fb-0020afe7292d)
132 dispinterface DShellFolderViewEvents
134 properties:
135 methods:
136 [id(DISPID_SELECTIONCHANGED)]
137 void SelectionChanged();
139 [id(DISPID_FILELISTENUMDONE)]
140 void EnumDone();
142 [id(DISPID_VERBINVOKED)]
143 VARIANT_BOOL VerbInvoked();
145 [id(DISPID_DEFAULTVERBINVOKED)]
146 VARIANT_BOOL DefaultVerbInvoked();
148 [id(DISPID_BEGINDRAG)]
149 VARIANT_BOOL BeginDrag();
153 uuid(9ba05971-f6a8-11cf-a442-00a0c90a8f39),
154 hidden
156 coclass ShellFolderViewOC
158 [default] interface IFolderViewOC;
159 [default, source] dispinterface DShellFolderViewEvents;
162 interface FolderItem;
163 interface FolderItems;
164 interface FolderItemVerb;
165 interface FolderItemVerbs;
167 /*****************************************************************************
168 * Folder interface
171 object,
172 uuid(bbcbde60-c3ff-11ce-8350-444553540000),
173 oleautomation,
174 dual
176 interface Folder : IDispatch
178 [propget, id(DISPID_VALUE)]
179 HRESULT Title( [out, retval] BSTR *pbs );
181 [propget]
182 HRESULT Application( [out, retval] IDispatch **ppid );
184 [propget]
185 HRESULT Parent( [out, retval] IDispatch **ppid );
187 [propget]
188 HRESULT ParentFolder( [out, retval] Folder **ppsf );
190 HRESULT Items( [out, retval] FolderItems **ppid );
192 HRESULT ParseName( [in] BSTR bName, [out, retval] FolderItem **ppid );
194 HRESULT NewFolder( [in] BSTR bName, [in, optional] VARIANT vOptions );
196 HRESULT MoveHere( [in] VARIANT vItem, [in, optional] VARIANT vOptions );
198 HRESULT CopyHere( [in] VARIANT vItem, [in, optional] VARIANT vOptions );
200 HRESULT GetDetailsOf( [in] VARIANT vItem,
201 [in] int iColumn,
202 [out, retval] BSTR *pbs );
205 /*****************************************************************************
206 * Folder2 interface
209 object,
210 uuid(f0d2d8ef-3890-11d2-bf8b-00c04fb93661),
211 oleautomation,
212 dual
214 interface Folder2 : Folder
216 [propget]
217 HRESULT Self( [out, retval] FolderItem **ppfi );
219 [propget]
220 HRESULT OfflineStatus( [out, retval] LONG *pul );
222 HRESULT Synchronize();
224 [propget, id(1)]
225 HRESULT HaveToShowWebViewBarricade(
226 [out, retval] VARIANT_BOOL *pbHaveToShowWebViewBarricade );
228 HRESULT DismissedWebViewBarricade();
231 /*****************************************************************************
232 * Folder3 interface
235 object,
236 uuid(a7ae5f64-c4d7-4d7f-9307-4d24ee54b841),
237 oleautomation,
238 dual
240 interface Folder3 : Folder2
242 [propget, id(2)]
243 HRESULT ShowWebViewBarricade(
244 [out, retval] VARIANT_BOOL *pbShowWebViewBarricade );
246 [propput, id(2)]
247 HRESULT ShowWebViewBarricade( [in] VARIANT_BOOL bShowWebViewBarricade );
250 /*****************************************************************************
251 * FolderItem interface
254 object,
255 uuid(fac32c80-cbe4-11ce-8350-444553540000),
256 oleautomation,
257 dual
259 interface FolderItem : IDispatch
261 typedef FolderItem *LPFOLDERITEM;
263 [propget]
264 HRESULT Application( [out, retval] IDispatch **ppid );
266 [propget]
267 HRESULT Parent( [out, retval] IDispatch **ppid );
269 [propget, id(DISPID_VALUE)]
270 HRESULT Name( [out, retval] BSTR *pbs );
272 [propput, id(DISPID_VALUE)]
273 HRESULT Name( [in] BSTR bs );
275 [propget]
276 HRESULT Path( [out, retval] BSTR *pbs );
278 [propget]
279 HRESULT GetLink( [out, retval] IDispatch **ppid );
281 [propget]
282 HRESULT GetFolder( [out, retval] IDispatch **ppid );
284 [propget]
285 HRESULT IsLink( [out, retval] VARIANT_BOOL *pb );
287 [propget]
288 HRESULT IsFolder( [out, retval] VARIANT_BOOL *pb );
290 [propget]
291 HRESULT IsFileSystem( [out, retval] VARIANT_BOOL *pb );
293 [propget]
294 HRESULT IsBrowsable( [out, retval] VARIANT_BOOL *pb );
296 [propget]
297 HRESULT ModifyDate( [out, retval] DATE *pdt );
299 [propput]
300 HRESULT ModifyDate( [in] DATE dt );
302 [propget]
303 HRESULT Size( [out, retval] LONG *pul );
305 [propget]
306 HRESULT Type( [out, retval] BSTR *pbs );
308 HRESULT Verbs( [out, retval] FolderItemVerbs **ppfic );
310 HRESULT InvokeVerb( [in, optional] VARIANT vVerb );
314 object,
315 uuid(edc817aa-92b8-11d1-b075-00c04fc33aa5),
316 oleautomation,
317 dual
319 interface FolderItem2 : FolderItem
321 HRESULT InvokeVerbEx([in, optional] VARIANT verb, [in, optional] VARIANT args);
322 HRESULT ExtendedProperty([in] BSTR propname, [out, retval] VARIANT *ret);
325 /*****************************************************************************
326 * FolderItems interface
329 object,
330 uuid(744129e0-cbe5-11ce-8350-444553540000),
331 oleautomation,
332 dual
334 interface FolderItems : IDispatch
336 [propget]
337 HRESULT Count( [out, retval] long *plCount );
339 [propget]
340 HRESULT Application( [out, retval] IDispatch **ppid );
342 [propget]
343 HRESULT Parent( [out, retval] IDispatch **ppid );
345 HRESULT Item( [in, optional] VARIANT index,
346 [out, retval] FolderItem **ppid );
348 [id(DISPID_NEWENUM)]
349 HRESULT _NewEnum( [out, retval] IUnknown **ppunk );
352 /*****************************************************************************
353 * FolderItemVerb interface
356 object,
357 uuid(08ec3e00-50b0-11cf-960c-0080c7f4ee85),
358 oleautomation,
359 dual
361 interface FolderItemVerb : IDispatch
363 [propget]
364 HRESULT Application( [out, retval] IDispatch **ppid );
366 [propget]
367 HRESULT Parent( [out, retval] IDispatch **ppid );
369 [propget, id(DISPID_VALUE)]
370 HRESULT Name( [out, retval] BSTR *pbs );
372 HRESULT DoIt();
375 /*****************************************************************************
376 * FolderItemVerbs interface
379 object,
380 uuid(1f8352c0-50b0-11cf-960c-0080c7f4ee85),
381 oleautomation,
382 dual
384 interface FolderItemVerbs : IDispatch
386 [propget]
387 HRESULT Count( [out, retval] long *plCount );
389 [propget]
390 HRESULT Application( [out, retval] IDispatch **ppid );
392 [propget]
393 HRESULT Parent( [out, retval] IDispatch **ppid );
395 HRESULT Item( [in, optional] VARIANT index,
396 [out, retval] FolderItemVerb **ppid );
398 [id(DISPID_NEWENUM)]
399 HRESULT _NewEnum( [out, retval] IUnknown **ppunk );
402 /*****************************************************************************
403 * IShellDispatch interface
406 uuid(d8f015c0-c278-11ce-a49e-444553540000),
407 oleautomation,
408 hidden,
409 dual
411 interface IShellDispatch : IDispatch
413 [propget]
414 HRESULT Application( [out, retval] IDispatch **ppid );
416 [propget]
417 HRESULT Parent( [out, retval] IDispatch **ppid );
419 HRESULT NameSpace( [in] VARIANT vDir, [out, retval] Folder **ppsdf );
421 HRESULT BrowseForFolder( [in] long Hwnd,
422 [in] BSTR Title,
423 [in] long Options,
424 [in, optional] VARIANT RootFolder,
425 [out, retval] Folder **ppsdf );
427 HRESULT Windows( [out, retval] IDispatch **ppid );
429 HRESULT Open( [in] VARIANT vDir );
431 HRESULT Explore( [in] VARIANT vDir );
433 HRESULT MinimizeAll();
435 HRESULT UndoMinimizeALL();
437 HRESULT FileRun();
439 HRESULT CascadeWindows();
441 HRESULT TileVertically();
443 HRESULT TileHorizontally();
445 HRESULT ShutdownWindows();
447 HRESULT Suspend();
449 HRESULT EjectPC();
451 HRESULT SetTime();
453 HRESULT TrayProperties();
455 HRESULT Help();
457 HRESULT FindFiles();
459 HRESULT FindComputer();
461 HRESULT RefreshMenu();
463 HRESULT ControlPanelItem( [in] BSTR szDir );
467 uuid(a4c6892c-3ba9-11d2-9dea-00c04fb16162),
468 oleautomation,
469 hidden,
470 dual
472 interface IShellDispatch2 : IShellDispatch
474 HRESULT IsRestricted([in] BSTR group, [in] BSTR restriction, [out, retval] long *value);
475 HRESULT ShellExecute([in] BSTR file, [in, optional] VARIANT args, [in, optional] VARIANT dir,
476 [in, optional] VARIANT op, [in, optional] VARIANT show);
477 HRESULT FindPrinter([in, optional] BSTR name, [in, optional] BSTR location, [in, optional] BSTR model);
478 HRESULT GetSystemInformation([in] BSTR name, [out, retval] VARIANT *ret);
479 HRESULT ServiceStart([in] BSTR service, [in] VARIANT persistent, [out, retval] VARIANT *ret);
480 HRESULT ServiceStop([in] BSTR service, [in] VARIANT persistent, [out, retval] VARIANT *ret);
481 HRESULT IsServiceRunning([in] BSTR service, [out, retval] VARIANT *running);
482 HRESULT CanStartStopService([in] BSTR service, [out, retval] VARIANT *ret);
483 HRESULT ShowBrowserBar([in] BSTR clsid, [in] VARIANT show, [out, retval] VARIANT *ret);
487 uuid(177160ca-bb5a-411c-841d-bd38facdeaa0),
488 oleautomation,
489 hidden,
490 dual
492 interface IShellDispatch3 : IShellDispatch2
494 HRESULT AddToRecent([in] VARIANT file, [in, optional] BSTR category);
498 uuid(efd84b2d-4bcf-4298-be25-eb542a59fbda),
499 oleautomation,
500 hidden,
501 dual
503 interface IShellDispatch4 : IShellDispatch3
505 HRESULT WindowsSecurity();
506 HRESULT ToggleDesktop();
507 HRESULT ExplorerPolicy([in] BSTR policy, [out, retval] VARIANT *value);
508 HRESULT GetSetting([in] long setting, [out,retval] VARIANT_BOOL *result);
512 uuid(866738b9-6cf2-4de8-8767-f794ebe74f4e),
513 oleautomation,
514 hidden,
515 dual
517 interface IShellDispatch5 : IShellDispatch4
519 HRESULT WindowSwitcher();
523 uuid(286e6f1b-7113-4355-9562-96b7e9d64c54),
524 oleautomation,
525 hidden,
526 dual,
528 interface IShellDispatch6 : IShellDispatch5
530 HRESULT SearchCommand(void);
534 uuid(13709620-c279-11ce-a49e-444553540000)
536 coclass Shell
538 [default] interface IShellDispatch6;
542 uuid(0a89a860-d7b1-11ce-8350-444553540000),
543 hidden
545 coclass ShellDispatchInproc
547 interface IUnknown;
550 typedef
552 uuid(ca31ea20-48d0-11cf-8350-444553540000)
554 enum ShellSpecialFolderConstants {
555 ssfDESKTOP = 0x00,
556 ssfPROGRAMS = 0x02,
557 ssfCONTROLS = 0x03,
558 ssfPRINTERS = 0x04,
559 ssfPERSONAL = 0x05,
560 ssfFAVORITES = 0x06,
561 ssfSTARTUP = 0x07,
562 ssfRECENT = 0x08,
563 ssfSENDTO = 0x09,
564 ssfBITBUCKET = 0x0a,
565 ssfSTARTMENU = 0x0b,
566 ssfDESKTOPDIRECTORY = 0x10,
567 ssfDRIVES = 0x11,
568 ssfNETWORK = 0x12,
569 ssfNETHOOD = 0x13,
570 ssfFONTS = 0x14,
571 ssfTEMPLATES = 0x15,
572 ssfCOMMONSTARTMENU = 0x16,
573 ssfCOMMONPROGRAMS = 0x17,
574 ssfCOMMONSTARTUP = 0x18,
575 ssfCOMMONDESKTOPDIR = 0x19,
576 ssfAPPDATA = 0x1a,
577 ssfPRINTHOOD = 0x1b,
578 ssfLOCALAPPDATA = 0x1c,
579 ssfALTSTARTUP = 0x1d,
580 ssfCOMMONALTSTARTUP = 0x1e,
581 ssfCOMMONFAVORITES = 0x1f,
582 ssfINTERNETCACHE = 0x20,
583 ssfCOOKIES = 0x21,
584 ssfHISTORY = 0x22,
585 ssfCOMMONAPPDATA = 0x23,
586 ssfWINDOWS = 0x24,
587 ssfSYSTEM = 0x25,
588 ssfPROGRAMFILES = 0x26,
589 ssfMYPICTURES = 0x27,
590 ssfPROFILE = 0x28,
591 ssfSYSTEMx86 = 0x29,
592 ssfPROGRAMFILESx86 = 0x30
593 } ShellSpecialFolderConstants;
595 /*****************************************************************************
596 * IShellFolderViewDual interface
598 typedef
600 uuid(742a99a0-c77e-11d0-a32c-00a0c91eedba)
602 enum ShellFolderViewOptions
604 SFVVO_SHOWALLOBJECTS = 0x00000001,
605 SFVVO_SHOWEXTENSIONS = 0x00000002,
606 SFVVO_SHOWCOMPCOLOR = 0x00000008,
607 SFVVO_SHOWSYSFILES = 0x00000020,
608 SFVVO_WIN95CLASSIC = 0x00000040,
609 SFVVO_DOUBLECLICKINWEBVIEW = 0x00000080,
610 SFVVO_DESKTOPHTML = 0x00000200
611 } ShellFolderViewOptions;
614 uuid(e7a1af80-4d96-11cf-960c-0080c7f4ee85),
615 oleautomation,
616 hidden,
617 dual
619 interface IShellFolderViewDual : IDispatch
621 [propget]
622 HRESULT Application([out, retval] IDispatch **app);
624 [propget]
625 HRESULT Parent([out, retval] IDispatch **parent);
627 [propget]
628 HRESULT Folder([out, retval] Folder **folder);
630 HRESULT SelectedItems([out, retval] FolderItems **items);
632 [propget]
633 HRESULT FocusedItem([out, retval] FolderItem **item);
635 HRESULT SelectItem([in] VARIANT *item, [in] int flags);
637 HRESULT PopupItemMenu([in] FolderItem *item,
638 [in, optional] VARIANT vx,
639 [in, optional] VARIANT vy,
640 [out, retval] BSTR *command);
641 [propget]
642 HRESULT Script([out, retval] IDispatch **script);
644 [propget]
645 HRESULT ViewOptions([out, retval] long *options);
649 uuid(31c147b6-0ade-4a3c-b514-ddf932ef6d17),
650 oleautomation,
651 hidden,
652 dual
654 interface IShellFolderViewDual2 : IShellFolderViewDual
656 [propget]
657 HRESULT CurrentViewMode([out, retval] UINT *mode);
659 [propput]
660 HRESULT CurrentViewMode([in] UINT mode);
662 HRESULT SelectItemRelative([in] int relative);
666 uuid(29ec8e6c-46d3-411f-baaa-611a6c9cac66),
667 oleautomation,
668 hidden,
669 dual
671 interface IShellFolderViewDual3 : IShellFolderViewDual2
673 [propget]
674 HRESULT GroupBy([out, retval] BSTR *groupby);
676 [propput]
677 HRESULT GroupBy([in] BSTR groupby);
679 [propget]
680 HRESULT FolderFlags([out, retval] DWORD *flags);
682 [propput]
683 HRESULT FolderFlags([in] DWORD flags);
685 [propget]
686 HRESULT SortColumns([out, retval] BSTR *sortcolumns);
688 [propput]
689 HRESULT SortColumns([in] BSTR sortcolumns);
691 [propput]
692 HRESULT IconSize([in] int icon_size);
694 [propget]
695 HRESULT IconSize([out, retval] int *icon_size);
697 HRESULT FilterView([in, unique] BSTR filter_text);
701 uuid(62112aa1-ebe4-11cf-a5fb-0020afe7292d)
703 coclass ShellFolderView
705 [default] interface IShellFolderViewDual3;
706 [default, source] dispinterface DShellFolderViewEvents;
709 } /* library Shell32 */
711 /*****************************************************************************
712 * IAsyncOperation interface
715 uuid(3d8b0590-f691-11d2-8ea9-006097df5bd4),
716 object,
719 interface IAsyncOperation : IUnknown
721 typedef [unique] IAsyncOperation *LPASYNCOPERATION;
723 HRESULT SetAsyncMode([in] BOOL fDoOpAsync);
725 HRESULT GetAsyncMode([out] BOOL *pfIsOpAsync);
727 HRESULT StartOperation([in, unique, optional] IBindCtx *pbcReserved);
729 HRESULT InOperation([out] BOOL *pfInAsyncOp);
731 HRESULT EndOperation(
732 [in] HRESULT hResult,
733 [in, unique] IBindCtx *pbcReserved,
734 [in] DWORD dwEffects);