include/psdk/shldisp.idl

   1 /*
   2  * COM interfaces for shell objects
   3  *
   4  * Copyright (C) 2004 Maxime Bellengé
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  */
  20
  21 import "ocidl.idl";
  22
  23 #include <shdispid.h>
  24
  25 cpp_quote("#ifdef WINE_NO_UNICODE_MACROS")
  26 cpp_quote("#undef ShellExecute")
  27 cpp_quote("#endif")
  28
  29 /*****************************************************************************
  30  * IEnumACString interface
  31  */
  32 [
  33     local,
  34     object,
  35     uuid(8e74c210-cf9d-4eaf-a403-7356428f0a5a),
  36     pointer_default(unique)
  37 ]
  38 interface IEnumACString : IEnumString
  39 {
  40     typedef IEnumACString *PENUMACSTRING, *LPENUMACSTRING;
  41
  42     typedef enum _tagACENUMOPTION
  43     {
  44         ACEO_NONE            = 0x00000000,
  45         ACEO_MOSTRECENTFIRST = 0x00000001,
  46         ACEO_FIRSTUNUSED     = 0x00010000,
  47     } ACENUMOPTION;
  48
  49     HRESULT NextItem( [out] LPWSTR pszUrl,
  50                       [in] ULONG cchMax,
  51                       [out] ULONG *pulSortIndex);
  52
  53     HRESULT SetEnumOptions( [in] DWORD dwOptions );
  54
  55     HRESULT GetEnumOptions( [out] DWORD *pdwOptions );
  56 }
  57
  58 /*****************************************************************************
  59  * IAutoComplete interface
  60  */
  61 [
  62     local,
  63     object,
  64     uuid(00bb2762-6a77-11d0-a535-00c04fd7d062),
  65     pointer_default(unique)
  66 ]
  67 interface IAutoComplete : IUnknown
  68 {
  69     typedef IAutoComplete *LPAUTOCOMPLETE;
  70
  71     HRESULT Init( [in] HWND hwndEdit,
  72                   [in] IUnknown *punkACL,
  73                   [in] LPCOLESTR pwszRegKeyPath,
  74                   [in] LPCOLESTR pwszQuickComplete);
  75
  76     HRESULT Enable( [in] BOOL fEnable );
  77 }
  78
  79 /*****************************************************************************
  80  * IAutoComplete2 interface
  81  */
  82 [
  83     local,
  84     object,
  85     uuid(eac04bc0-3791-11d2-bb95-0060977b464c),
  86     pointer_default(unique)
  87 ]
  88 interface IAutoComplete2 : IAutoComplete
  89 {
  90     typedef IAutoComplete2 *LPAUTOCOMPLETE2;
  91
  92     typedef enum _tagAUTOCOMPLETEOPTIONS
  93         {
  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;
 103
 104     HRESULT SetOptions( [in] DWORD dwFlag);
 105
 106     HRESULT GetOptions( [out] DWORD *pdwFlag);
 107 }
 108
 109 [
 110     uuid(50a7e9b0-70ef-11d1-b75a-00a0c90564fe),
 111     version(1.0)
 112 ]
 113 library Shell32
 114 {
 115
 116 importlib("stdole2.tlb");
 117
 118 [
 119     object,
 120     oleautomation,
 121     uuid(9ba05970-f6a8-11cf-a442-00a0c90a8f39),
 122     pointer_default(unique)
 123 ]
 124 interface IFolderViewOC : IDispatch
 125 {
 126     HRESULT SetFolderView( [in] IDispatch *pdisp );
 127 }
 128
 129 [
 130     uuid(62112aa2-ebe4-11cf-a5fb-0020afe7292d)
 131 ]
 132 dispinterface DShellFolderViewEvents
 133 {
 134     properties:
 135     methods:
 136     [id(DISPID_SELECTIONCHANGED)]
 137     void SelectionChanged();
 138
 139     [id(DISPID_FILELISTENUMDONE)]
 140     void EnumDone();
 141
 142     [id(DISPID_VERBINVOKED)]
 143     VARIANT_BOOL VerbInvoked();
 144
 145     [id(DISPID_DEFAULTVERBINVOKED)]
 146     VARIANT_BOOL DefaultVerbInvoked();
 147
 148     [id(DISPID_BEGINDRAG)]
 149     VARIANT_BOOL BeginDrag();
 150 }
 151
 152 [
 153     uuid(9ba05971-f6a8-11cf-a442-00a0c90a8f39),
 154     hidden
 155 ]
 156 coclass ShellFolderViewOC
 157 {
 158     [default]         interface     IFolderViewOC;
 159     [default, source] dispinterface DShellFolderViewEvents;
 160 }
 161
 162 interface FolderItem;
 163 interface FolderItems;
 164 interface FolderItemVerb;
 165 interface FolderItemVerbs;
 166
 167 /*****************************************************************************
 168  * Folder interface
 169  */
 170 [
 171     object,
 172     uuid(bbcbde60-c3ff-11ce-8350-444553540000),
 173     oleautomation,
 174     dual
 175 ]
 176 interface Folder : IDispatch
 177 {
 178     [propget, id(DISPID_VALUE)]
 179     HRESULT Title( [out, retval] BSTR *pbs );
 180
 181     [propget]
 182     HRESULT Application( [out, retval] IDispatch **ppid );
 183
 184     [propget]
 185     HRESULT Parent( [out, retval] IDispatch **ppid );
 186
 187     [propget]
 188     HRESULT ParentFolder( [out, retval] Folder **ppsf );
 189
 190     HRESULT Items( [out, retval] FolderItems **ppid );
 191
 192     HRESULT ParseName( [in] BSTR bName, [out, retval] FolderItem **ppid );
 193
 194     HRESULT NewFolder( [in] BSTR bName, [in, optional] VARIANT vOptions );
 195
 196     HRESULT MoveHere( [in] VARIANT vItem, [in, optional] VARIANT vOptions );
 197
 198     HRESULT CopyHere( [in] VARIANT vItem, [in, optional] VARIANT vOptions );
 199
 200     HRESULT GetDetailsOf( [in] VARIANT vItem,
 201         [in] int iColumn,
 202         [out, retval] BSTR *pbs );
 203 }
 204
 205 /*****************************************************************************
 206  * Folder2 interface
 207  */
 208 [
 209     object,
 210     uuid(f0d2d8ef-3890-11d2-bf8b-00c04fb93661),
 211     oleautomation,
 212     dual
 213 ]
 214 interface Folder2 : Folder
 215 {
 216     [propget]
 217     HRESULT Self( [out, retval] FolderItem **ppfi );
 218
 219     [propget]
 220     HRESULT OfflineStatus( [out, retval] LONG *pul );
 221
 222     HRESULT Synchronize();
 223
 224     [propget, id(1)]
 225     HRESULT HaveToShowWebViewBarricade(
 226         [out, retval] VARIANT_BOOL *pbHaveToShowWebViewBarricade );
 227
 228     HRESULT DismissedWebViewBarricade();
 229 }
 230
 231 /*****************************************************************************
 232  * Folder3 interface
 233  */
 234 [
 235     object,
 236     uuid(a7ae5f64-c4d7-4d7f-9307-4d24ee54b841),
 237     oleautomation,
 238     dual
 239 ]
 240 interface Folder3 : Folder2
 241 {
 242     [propget, id(2)]
 243     HRESULT ShowWebViewBarricade(
 244         [out, retval] VARIANT_BOOL *pbShowWebViewBarricade );
 245
 246     [propput, id(2)]
 247     HRESULT ShowWebViewBarricade( [in] VARIANT_BOOL bShowWebViewBarricade );
 248 }
 249
 250 /*****************************************************************************
 251  * FolderItem interface
 252  */
 253 [
 254     object,
 255     uuid(fac32c80-cbe4-11ce-8350-444553540000),
 256     oleautomation,
 257     dual
 258 ]
 259 interface FolderItem : IDispatch
 260 {
 261     typedef FolderItem *LPFOLDERITEM;
 262
 263     [propget]
 264     HRESULT Application( [out, retval] IDispatch **ppid );
 265
 266     [propget]
 267     HRESULT Parent( [out, retval] IDispatch **ppid );
 268
 269     [propget, id(DISPID_VALUE)]
 270     HRESULT Name( [out, retval] BSTR *pbs );
 271
 272     [propput, id(DISPID_VALUE)]
 273     HRESULT Name( [in] BSTR bs );
 274
 275     [propget]
 276     HRESULT Path( [out, retval] BSTR *pbs );
 277
 278     [propget]
 279     HRESULT GetLink( [out, retval] IDispatch **ppid );
 280
 281     [propget]
 282     HRESULT GetFolder( [out, retval] IDispatch **ppid );
 283
 284     [propget]
 285     HRESULT IsLink( [out, retval] VARIANT_BOOL *pb );
 286
 287     [propget]
 288     HRESULT IsFolder( [out, retval] VARIANT_BOOL *pb );
 289
 290     [propget]
 291     HRESULT IsFileSystem( [out, retval] VARIANT_BOOL *pb );
 292
 293     [propget]
 294     HRESULT IsBrowsable( [out, retval] VARIANT_BOOL *pb );
 295
 296     [propget]
 297     HRESULT ModifyDate( [out, retval] DATE *pdt );
 298
 299     [propput]
 300     HRESULT ModifyDate( [in] DATE dt );
 301
 302     [propget]
 303     HRESULT Size( [out, retval] LONG *pul );
 304
 305     [propget]
 306     HRESULT Type( [out, retval] BSTR *pbs );
 307
 308     HRESULT Verbs( [out, retval] FolderItemVerbs **ppfic );
 309
 310     HRESULT InvokeVerb( [in, optional] VARIANT vVerb );
 311 }
 312
 313 [
 314     object,
 315     uuid(edc817aa-92b8-11d1-b075-00c04fc33aa5),
 316     oleautomation,
 317     dual
 318 ]
 319 interface FolderItem2 : FolderItem
 320 {
 321     HRESULT InvokeVerbEx( [in, optional] VARIANT vVerb, [in, optional] VARIANT vArgs );
 322
 323     HRESULT ExtendedProperty( [in] BSTR sPropName, [out, retval] VARIANT *pvRet );
 324 }
 325
 326 [
 327     uuid(2fe352ea-fd1f-11d2-b1f4-00c04f8eeb3e)
 328 ]
 329 coclass ShellFolderItem
 330 {
 331     interface FolderItem2;
 332 }
 333
 334 /*****************************************************************************
 335  * FolderItems interface
 336  */
 337 [
 338     object,
 339     uuid(744129e0-cbe5-11ce-8350-444553540000),
 340     oleautomation,
 341     dual
 342 ]
 343 interface FolderItems : IDispatch
 344 {
 345     [propget]
 346     HRESULT Count( [out, retval] long *plCount );
 347
 348     [propget]
 349     HRESULT Application( [out, retval] IDispatch **ppid );
 350
 351     [propget]
 352     HRESULT Parent( [out, retval] IDispatch **ppid );
 353
 354     HRESULT Item( [in, optional] VARIANT index,
 355         [out, retval] FolderItem **ppid );
 356
 357     [id(DISPID_NEWENUM)]
 358     HRESULT _NewEnum( [out, retval] IUnknown **ppunk );
 359 }
 360
 361 /*****************************************************************************
 362  * FolderItemVerb interface
 363  */
 364 [
 365     object,
 366     uuid(08ec3e00-50b0-11cf-960c-0080c7f4ee85),
 367     oleautomation,
 368     dual
 369 ]
 370 interface FolderItemVerb : IDispatch
 371 {
 372     [propget]
 373     HRESULT Application( [out, retval] IDispatch **ppid );
 374
 375     [propget]
 376     HRESULT Parent( [out, retval] IDispatch **ppid );
 377
 378     [propget, id(DISPID_VALUE)]
 379     HRESULT Name( [out, retval] BSTR *pbs );
 380
 381     HRESULT DoIt();
 382 }
 383
 384 /*****************************************************************************
 385  * FolderItemVerbs interface
 386  */
 387 [
 388     object,
 389     uuid(1f8352c0-50b0-11cf-960c-0080c7f4ee85),
 390     oleautomation,
 391     dual
 392 ]
 393 interface FolderItemVerbs : IDispatch
 394 {
 395     [propget]
 396     HRESULT Count( [out, retval] long *plCount );
 397
 398     [propget]
 399     HRESULT Application( [out, retval] IDispatch **ppid );
 400
 401     [propget]
 402     HRESULT Parent( [out, retval] IDispatch **ppid );
 403
 404     HRESULT Item( [in, optional] VARIANT index,
 405         [out, retval] FolderItemVerb **ppid );
 406
 407     [id(DISPID_NEWENUM)]
 408     HRESULT _NewEnum( [out, retval] IUnknown **ppunk );
 409 }
 410
 411 /*****************************************************************************
 412  * IShellDispatch interface
 413  */
 414 [
 415     object,
 416     uuid(d8f015c0-c278-11ce-a49e-444553540000),
 417     oleautomation,
 418     hidden,
 419     dual
 420 ]
 421 interface IShellDispatch : IDispatch
 422 {
 423     [propget]
 424     HRESULT Application( [out, retval] IDispatch **ppid );
 425
 426     [propget]
 427     HRESULT Parent( [out, retval] IDispatch **ppid );
 428
 429     HRESULT NameSpace( [in] VARIANT vDir, [out, retval] Folder **ppsdf );
 430
 431     HRESULT BrowseForFolder( [in] long Hwnd,
 432         [in] BSTR Title,
 433         [in] long Options,
 434         [in, optional] VARIANT RootFolder,
 435         [out, retval] Folder **ppsdf );
 436
 437     HRESULT Windows( [out, retval] IDispatch **ppid );
 438
 439     HRESULT Open( [in] VARIANT vDir );
 440
 441     HRESULT Explore( [in] VARIANT vDir );
 442
 443     HRESULT MinimizeAll();
 444
 445     HRESULT UndoMinimizeALL();
 446
 447     HRESULT FileRun();
 448
 449     HRESULT CascadeWindows();
 450
 451     HRESULT TileVertically();
 452
 453     HRESULT TileHorizontally();
 454
 455     HRESULT ShutdownWindows();
 456
 457     HRESULT Suspend();
 458
 459     HRESULT EjectPC();
 460
 461     HRESULT SetTime();
 462
 463     HRESULT TrayProperties();
 464
 465     HRESULT Help();
 466
 467     HRESULT FindFiles();
 468
 469     HRESULT FindComputer();
 470
 471     HRESULT RefreshMenu();
 472
 473     HRESULT ControlPanelItem( [in] BSTR szDir );
 474 }
 475
 476 [
 477     object,
 478     uuid(a4c6892c-3ba9-11d2-9dea-00c04fb16162),
 479     oleautomation,
 480     hidden,
 481     dual,
 482 ]
 483 interface IShellDispatch2 : IShellDispatch
 484 {
 485     HRESULT IsRestricted([in] BSTR group, [in] BSTR restriction, [out, retval] long *value);
 486     HRESULT ShellExecute([in] BSTR file, [in, optional] VARIANT args, [in, optional] VARIANT dir,
 487         [in, optional] VARIANT op, [in, optional] VARIANT show);
 488     HRESULT FindPrinter([in, optional] BSTR name, [in, optional] BSTR location, [in, optional] BSTR model);
 489     HRESULT GetSystemInformation([in] BSTR name, [out, retval] VARIANT *ret);
 490     HRESULT ServiceStart([in] BSTR service, [in] VARIANT persistent, [out, retval] VARIANT *ret);
 491     HRESULT ServiceStop([in] BSTR service, [in] VARIANT persistent, [out, retval] VARIANT *ret);
 492     HRESULT IsServiceRunning([in] BSTR service, [out, retval] VARIANT *running);
 493     HRESULT CanStartStopService([in] BSTR service, [out, retval] VARIANT *ret);
 494     HRESULT ShowBrowserBar([in] BSTR clsid, [in] VARIANT show, [out, retval] VARIANT *ret);
 495 }
 496
 497 [
 498     uuid(13709620-c279-11ce-a49e-444553540000)
 499 ]
 500 coclass Shell
 501 {
 502     [default] interface IShellDispatch2;
 503 }
 504
 505 [
 506     uuid(0a89a860-d7b1-11ce-8350-444553540000),
 507     hidden
 508 ]
 509 coclass ShellDispatchInproc
 510 {
 511     interface IUnknown;
 512 }
 513
 514 typedef
 515 [
 516     uuid(ca31ea20-48d0-11cf-8350-444553540000)
 517 ]
 518 enum ShellSpecialFolderConstants {
 519     ssfDESKTOP          = 0x00,
 520     ssfPROGRAMS         = 0x02,
 521     ssfCONTROLS         = 0x03,
 522     ssfPRINTERS         = 0x04,
 523     ssfPERSONAL         = 0x05,
 524     ssfFAVORITES        = 0x06,
 525     ssfSTARTUP          = 0x07,
 526     ssfRECENT           = 0x08,
 527     ssfSENDTO           = 0x09,
 528     ssfBITBUCKET        = 0x0a,
 529     ssfSTARTMENU        = 0x0b,
 530     ssfDESKTOPDIRECTORY = 0x10,
 531     ssfDRIVES           = 0x11,
 532     ssfNETWORK          = 0x12,
 533     ssfNETHOOD          = 0x13,
 534     ssfFONTS            = 0x14,
 535     ssfTEMPLATES        = 0x15,
 536     ssfCOMMONSTARTMENU  = 0x16,
 537     ssfCOMMONPROGRAMS   = 0x17,
 538     ssfCOMMONSTARTUP    = 0x18,
 539     ssfCOMMONDESKTOPDIR = 0x19,
 540     ssfAPPDATA          = 0x1a,
 541     ssfPRINTHOOD        = 0x1b,
 542     ssfLOCALAPPDATA     = 0x1c,
 543     ssfALTSTARTUP       = 0x1d,
 544     ssfCOMMONALTSTARTUP = 0x1e,
 545     ssfCOMMONFAVORITES  = 0x1f,
 546     ssfINTERNETCACHE    = 0x20,
 547     ssfCOOKIES          = 0x21,
 548     ssfHISTORY          = 0x22,
 549     ssfCOMMONAPPDATA    = 0x23,
 550     ssfWINDOWS          = 0x24,
 551     ssfSYSTEM           = 0x25,
 552     ssfPROGRAMFILES     = 0x26,
 553     ssfMYPICTURES       = 0x27,
 554     ssfPROFILE          = 0x28,
 555     ssfSYSTEMx86        = 0x29,
 556     ssfPROGRAMFILESx86  = 0x30
 557 } ShellSpecialFolderConstants;
 558
 559 } /* library Shell32 */
 560
 561 /*****************************************************************************
 562  * IAsyncOperation interface
 563  */
 564 [
 565     uuid(3d8b0590-f691-11d2-8ea9-006097df5bd4),
 566     object,
 567 ]
 568
 569 interface IAsyncOperation : IUnknown
 570 {
 571     typedef [unique] IAsyncOperation *LPASYNCOPERATION;
 572
 573     HRESULT SetAsyncMode([in] BOOL fDoOpAsync);
 574
 575     HRESULT GetAsyncMode([out] BOOL *pfIsOpAsync);
 576
 577     HRESULT StartOperation([in, unique, optional] IBindCtx *pbcReserved);
 578
 579     HRESULT InOperation([out] BOOL *pfInAsyncOp);
 580
 581     HRESULT EndOperation(
 582             [in] HRESULT hResult,
 583             [in, unique] IBindCtx *pbcReserved,
 584             [in] DWORD dwEffects);
 585 }