include/dhtmled.idl

   1 /*
   2  * Copyright 2017 Alex Henrie
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  17  */
  18
  19 import "oaidl.idl";
  20 import "ocidl.idl";
  21 import "docobj.idl";
  22 import "mshtml.idl";
  23
  24 #include "dhtmldid.h"
  25
  26 #ifndef __WIDL__
  27 #define threading(model)
  28 #define progid(str)
  29 #define vi_progid(str)
  30 #endif
  31
  32 [
  33     uuid(683364a1-b37d-11d1-adc5-006008a5848c),
  34     version(1.0)
  35 ]
  36 library DHTMLEDLib
  37 {
  38     importlib("stdole2.tlb");
  39
  40     typedef
  41     [
  42         uuid(7179FC44-B2E4-11d1-ADC5-006008A5848C)
  43     ]
  44     enum DHTMLEDITAPPEARANCE {
  45         DEAPPEARANCE_FLAT,
  46         DEAPPEARANCE_3D
  47     } DHTMLEDITAPPEARANCE;
  48
  49     typedef
  50     [
  51         uuid(bf82426a-b961-11d1-adc5-006008a5848c)
  52     ]
  53     enum DHTMLEDITCMDF {
  54         DECMDF_NOTSUPPORTED = 0,
  55         DECMDF_DISABLED = 1,
  56         DECMDF_ENABLED = 3,
  57         DECMDF_LATCHED = 7,
  58         DECMDF_NINCHED = 11
  59     } DHTMLEDITCMDF;
  60
  61     typedef enum DHTMLEDITCMDID {
  62         DECMD_BOLD = 5000,
  63         DECMD_COPY = 5002,
  64         DECMD_CUT,
  65         DECMD_DELETE,
  66         DECMD_DELETECELLS,
  67         DECMD_DELETECOLS,
  68         DECMD_DELETEROWS,
  69         DECMD_FINDTEXT,
  70         DECMD_FONT,
  71         DECMD_GETBACKCOLOR,
  72         DECMD_GETBLOCKFMT,
  73         DECMD_GETBLOCKFMTNAMES,
  74         DECMD_GETFONTNAME,
  75         DECMD_GETFONTSIZE,
  76         DECMD_GETFORECOLOR,
  77         DECMD_HYPERLINK,
  78         DECMD_IMAGE,
  79         DECMD_INDENT,
  80         DECMD_INSERTCELL,
  81         DECMD_INSERTCOL,
  82         DECMD_INSERTROW,
  83         DECMD_INSERTTABLE,
  84         DECMD_ITALIC,
  85         DECMD_JUSTIFYCENTER,
  86         DECMD_JUSTIFYLEFT,
  87         DECMD_JUSTIFYRIGHT,
  88         DECMD_LOCK_ELEMENT,
  89         DECMD_MAKE_ABSOLUTE,
  90         DECMD_MERGECELLS,
  91         DECMD_ORDERLIST,
  92         DECMD_OUTDENT,
  93         DECMD_PASTE,
  94         DECMD_REDO,
  95         DECMD_REMOVEFORMAT,
  96         DECMD_SELECTALL,
  97         DECMD_SEND_BACKWARD,
  98         DECMD_BRING_FORWARD,
  99         DECMD_SEND_BELOW_TEXT,
 100         DECMD_BRING_ABOVE_TEXT,
 101         DECMD_SEND_TO_BACK,
 102         DECMD_BRING_TO_FRONT,
 103         DECMD_SETBACKCOLOR,
 104         DECMD_SETBLOCKFMT,
 105         DECMD_SETFONTNAME,
 106         DECMD_SETFONTSIZE,
 107         DECMD_SETFORECOLOR,
 108         DECMD_SPLITCELL,
 109         DECMD_UNDERLINE,
 110         DECMD_UNDO,
 111         DECMD_UNLINK,
 112         DECMD_UNORDERLIST,
 113         DECMD_PROPERTIES
 114     } DHTMLEDITCMDID;
 115
 116     [
 117         object,
 118         uuid(ce04b590-2b1f-11d2-8d1e-00a0c959bc0a),
 119         dual,
 120         pointer_default(unique)
 121     ]
 122     interface IDHTMLSafe : IDispatch
 123     {
 124         [
 125             id(DISPID_EXECCOMMAND)
 126         ]
 127         HRESULT ExecCommand(
 128             [in] DHTMLEDITCMDID cmd_id,
 129             [in, defaultvalue(OLECMDEXECOPT_DODEFAULT)] OLECMDEXECOPT options,
 130             [in, optional] VARIANT *code_in,
 131             [out, retval] VARIANT *code_out
 132         );
 133
 134         [
 135             id(DISPID_QUERYSTATUS)
 136         ]
 137         HRESULT QueryStatus(
 138             [in] DHTMLEDITCMDID cmd_id,
 139             [out, retval] DHTMLEDITCMDF *status
 140         );
 141
 142         [
 143             id(DISPID_SETCONTEXTMENU)
 144         ]
 145         HRESULT SetContextMenu(
 146             [in] VARIANT *strings,
 147             [in] VARIANT *states
 148         );
 149
 150         [
 151             id(DISPID_NEWDOCUMENT)
 152         ]
 153         HRESULT NewDocument();
 154
 155         [
 156             id(DISPID_LOADURL)
 157         ]
 158         HRESULT LoadURL(
 159             [in] BSTR url
 160         );
 161
 162         [
 163             id(DISPID_FILTERSRCCODE)
 164         ]
 165         HRESULT FilterSourceCode(
 166             [in] BSTR in,
 167             [out, retval] BSTR *out
 168         );
 169
 170         [
 171             id(DISPID_REFRESHDOC)
 172         ]
 173         HRESULT Refresh();
 174
 175         [
 176             propget,
 177             id(DISPID_DOCUMENT)
 178         ]
 179         HRESULT DOM(
 180             [out, retval] IHTMLDocument2 **value
 181         );
 182
 183         [
 184             propget,
 185             id(DISPID_DOCUMENTHTML)
 186         ]
 187         HRESULT DocumentHTML(
 188             [out, retval] BSTR *value
 189         );
 190
 191         [
 192             propput,
 193             id(DISPID_DOCUMENTHTML)
 194         ]
 195         HRESULT DocumentHTML(
 196             [in] BSTR html
 197         );
 198
 199         [
 200             propget,
 201             id(DISPID_ACTIVATEAPPLETS)
 202         ]
 203         HRESULT ActivateApplets(
 204             [out, retval] VARIANT_BOOL *value
 205         );
 206
 207         [
 208             propput,
 209             id(DISPID_ACTIVATEAPPLETS)
 210         ]
 211         HRESULT ActivateApplets(
 212             [in] VARIANT_BOOL value
 213         );
 214
 215         [
 216             propget,
 217             id(DISPID_ACTIVATEACTIVEXCONTROLS)
 218         ]
 219         HRESULT ActivateActiveXControls(
 220             [out, retval] VARIANT_BOOL *value
 221         );
 222
 223         [
 224             propput,
 225             id(DISPID_ACTIVATEACTIVEXCONTROLS)
 226         ]
 227         HRESULT ActivateActiveXControls(
 228             [in] VARIANT_BOOL value
 229         );
 230
 231         [
 232             propget,
 233             id(DISPID_ACTIVATEDTCS)
 234         ]
 235         HRESULT ActivateDTCs(
 236             [out, retval] VARIANT_BOOL *value
 237         );
 238
 239         [
 240             propput,
 241             id(DISPID_ACTIVATEDTCS)
 242         ]
 243         HRESULT ActivateDTCs(
 244             [in] VARIANT_BOOL value
 245         );
 246
 247         [
 248             propget,
 249             id(DISPID_SHOWDETAILS)
 250         ]
 251         HRESULT ShowDetails(
 252             [out, retval] VARIANT_BOOL *value
 253         );
 254
 255         [
 256             propput,
 257             id(DISPID_SHOWDETAILS)
 258         ]
 259         HRESULT ShowDetails(
 260             [in] VARIANT_BOOL value
 261         );
 262
 263         [
 264             propget,
 265             id(DISPID_SHOWBORDERS)
 266         ]
 267         HRESULT ShowBorders(
 268             [out, retval] VARIANT_BOOL *value
 269         );
 270
 271         [
 272             propput,
 273             id(DISPID_SHOWBORDERS)
 274         ]
 275         HRESULT ShowBorders(
 276             [in] VARIANT_BOOL value
 277         );
 278
 279         [
 280             propget,
 281             id(DISPID_DHTMLEDITAPPEARANCE)
 282         ]
 283         HRESULT Appearance(
 284             [out, retval] DHTMLEDITAPPEARANCE *value
 285         );
 286
 287         [
 288             propput,
 289             id(DISPID_DHTMLEDITAPPEARANCE)
 290         ]
 291         HRESULT Appearance(
 292             [in] DHTMLEDITAPPEARANCE value
 293         );
 294
 295         [
 296             propget,
 297             id(DISPID_DHTMLEDITSCROLLBARS)
 298         ]
 299         HRESULT Scrollbars(
 300             [out, retval] VARIANT_BOOL *value
 301         );
 302
 303         [
 304             propput,
 305             id(DISPID_DHTMLEDITSCROLLBARS)
 306         ]
 307         HRESULT Scrollbars(
 308             [in] VARIANT_BOOL value
 309         );
 310
 311         [
 312             propget,
 313             id(DISPID_SCROLLBARAPPEARANCE)
 314         ]
 315         HRESULT ScrollbarAppearance(
 316             [out, retval] DHTMLEDITAPPEARANCE *value
 317         );
 318
 319         [
 320             propput,
 321             id(DISPID_SCROLLBARAPPEARANCE)
 322         ]
 323         HRESULT ScrollbarAppearance(
 324             [in] DHTMLEDITAPPEARANCE value
 325         );
 326
 327         [
 328             propget,
 329             id(DISPID_SOURCECODEPRESERVATION)
 330         ]
 331         HRESULT SourceCodePreservation(
 332             [out, retval] VARIANT_BOOL *value
 333         );
 334
 335         [
 336             propput,
 337             id(DISPID_SOURCECODEPRESERVATION)
 338         ]
 339         HRESULT SourceCodePreservation(
 340             [in] VARIANT_BOOL value
 341         );
 342
 343         [
 344             propget,
 345             id(DISPID_ABSOLUTEDROPMODE)
 346         ]
 347         HRESULT AbsoluteDropMode(
 348             [out, retval] VARIANT_BOOL *value
 349         );
 350
 351         [
 352             propput,
 353             id(DISPID_ABSOLUTEDROPMODE)
 354         ]
 355         HRESULT AbsoluteDropMode(
 356             [in] VARIANT_BOOL value
 357         );
 358
 359         [
 360             propget,
 361             id(DISPID_SNAPTOGRIDX)
 362         ]
 363         HRESULT SnapToGridX(
 364             [out, retval] long *value
 365         );
 366
 367         [
 368             propput,
 369             id(DISPID_SNAPTOGRIDX)
 370         ]
 371         HRESULT SnapToGridX(
 372             [in] long value
 373         );
 374
 375         [
 376             propget,
 377             id(DISPID_SNAPTOGRIDY)
 378         ]
 379         HRESULT SnapToGridY(
 380             [out, retval] long *value
 381         );
 382
 383         [
 384             propput,
 385             id(DISPID_SNAPTOGRIDY)
 386         ]
 387         HRESULT SnapToGridY(
 388             [in] long value
 389         );
 390
 391         [
 392             propget,
 393             id(DISPID_SNAPTOGRID)
 394         ]
 395         HRESULT SnapToGrid(
 396             [out, retval] VARIANT_BOOL *value
 397         );
 398
 399         [
 400             propput,
 401             id(DISPID_SNAPTOGRID)
 402         ]
 403         HRESULT SnapToGrid(
 404             [in] VARIANT_BOOL value
 405         );
 406
 407         [
 408             propget,
 409             id(DISPID_ISDIRTY)
 410         ]
 411         HRESULT IsDirty(
 412             [out, retval] VARIANT_BOOL *value
 413         );
 414
 415         [
 416             propget,
 417             id(DISPID_CURRENTDOCUMENTPATH)
 418         ]
 419         HRESULT CurrentDocumentPath(
 420             [out, retval] BSTR *value
 421         );
 422
 423         [
 424             propget,
 425             id(DISPID_BASEURL)
 426         ]
 427         HRESULT BaseURL(
 428             [out, retval] BSTR *value
 429         );
 430
 431         [
 432             propput,
 433             id(DISPID_BASEURL)
 434         ]
 435         HRESULT BaseURL(
 436             [in] BSTR value
 437         );
 438
 439         [
 440             propget,
 441             id(DISPID_DOCUMENTTITLE)
 442         ]
 443         HRESULT DocumentTitle(
 444             [out, retval] BSTR *value
 445         );
 446
 447         [
 448             propget,
 449             id(DISPID_USEDIVONCR)
 450         ]
 451         HRESULT UseDivOnCarriageReturn(
 452             [out, retval] VARIANT_BOOL *value
 453         );
 454
 455         [
 456             propput,
 457             id(DISPID_USEDIVONCR)
 458         ]
 459         HRESULT UseDivOnCarriageReturn(
 460             [in] VARIANT_BOOL value
 461         );
 462
 463         [
 464             propget,
 465             id(DISPID_BUSY)
 466         ]
 467         HRESULT Busy(
 468             [out, retval] VARIANT_BOOL *value
 469         );
 470     };
 471
 472     [
 473         uuid(d1fc78e8-b380-11d1-adc5-006008a5848c)
 474     ]
 475     dispinterface _DHTMLSafeEvents
 476     {
 477     properties:
 478     methods:
 479         [
 480             id(DISPID_DOCUMENTCOMPLETE)
 481         ]
 482         void DocumentComplete();
 483
 484         [
 485             id(DISPID_DISPLAYCHANGED)
 486         ]
 487         void DisplayChanged();
 488
 489         [
 490             id(DISPID_SHOWCONTEXTMENU)
 491         ]
 492         void ShowContextMenu(
 493             [in] long x,
 494             [in] long y
 495         );
 496
 497         [
 498             id(DISPID_CONTEXTMENUACTION)
 499         ]
 500         void ContextMenuAction(
 501             [in] long index
 502         );
 503
 504         [
 505             id(DISPID_ONMOUSEDOWN)
 506         ]
 507         void onmousedown();
 508
 509         [
 510             id(DISPID_ONMOUSEMOVE)
 511         ]
 512         void onmousemove();
 513
 514         [
 515             id(DISPID_ONMOUSEUP)
 516         ]
 517         void onmouseup();
 518
 519         [
 520             id(DISPID_ONMOUSEOUT)
 521         ]
 522         void onmouseout();
 523
 524         [
 525             id(DISPID_ONMOUSEOVER)
 526         ]
 527         void onmouseover();
 528
 529         [
 530             id(DISPID_ONCLICK)
 531         ]
 532         void onclick();
 533
 534         [
 535             id(DISPID_ONDBLCLICK)
 536         ]
 537         void ondblclick();
 538
 539         [
 540             id(DISPID_ONKEYDOWN)
 541         ]
 542         void onkeydown();
 543
 544         [
 545             id(DISPID_ONKEYPRESS)
 546         ]
 547         void onkeypress();
 548
 549         [
 550             id(DISPID_ONKEYUP)
 551         ]
 552         void onkeyup();
 553
 554         [
 555             id(DISPID_ONBLUR)
 556         ]
 557         void onblur();
 558
 559         [
 560             id(DISPID_ONREADYSTATECHANGE)
 561         ]
 562         void onreadystatechange();
 563     };
 564
 565     [
 566         uuid(2d360201-fff5-11d1-8d03-00a0c959bc0a),
 567         threading(apartment),
 568         progid("DHTMLSafe.DHTMLSafe.1"),
 569         vi_progid("DHTMLSafe.DHTMLSafe")
 570     ]
 571     coclass DHTMLSafe
 572     {
 573         [default] interface IDHTMLSafe;
 574         [default, source] interface _DHTMLSafeEvents;
 575     };
 576
 577     [
 578         uuid(ce04b591-2b1f-11d2-8d1e-00a0c959bc0a),
 579         dual,
 580         pointer_default(unique)
 581     ]
 582     interface IDHTMLEdit : IDHTMLSafe
 583     {
 584         [
 585             id(DISPID_LOADDOCUMENT)
 586         ]
 587         HRESULT LoadDocument(
 588             [in] VARIANT *path,
 589             [in, optional] VARIANT *prompt
 590         );
 591
 592         [
 593             id(DISPID_SAVEDOCUMENT)
 594         ]
 595         HRESULT SaveDocument(
 596             [in] VARIANT *path,
 597             [in, optional] VARIANT *prompt
 598         );
 599
 600         [
 601             id(DISPID_PRINT)
 602         ]
 603         HRESULT PrintDocument(
 604             [in, optional] VARIANT *prompt
 605         );
 606
 607         [
 608             propget,
 609             id(DISPID_BROWSEMODE)
 610         ]
 611         HRESULT BrowseMode(
 612             [out, retval] VARIANT_BOOL *value
 613         );
 614
 615         [
 616             propput,
 617             id(DISPID_BROWSEMODE)
 618         ]
 619         HRESULT BrowseMode(
 620             [in] VARIANT_BOOL value
 621         );
 622     };
 623
 624     [
 625         uuid(588d5040-cf28-11d1-8cd3-00a0c959bc0a)
 626     ]
 627     dispinterface _DHTMLEditEvents
 628     {
 629     properties:
 630     methods:
 631         [
 632             id(DISPID_DOCUMENTCOMPLETE)
 633         ]
 634         void DocumentComplete();
 635
 636         [
 637             id(DISPID_DISPLAYCHANGED)
 638         ]
 639         void DisplayChanged();
 640
 641         [
 642             id(DISPID_SHOWCONTEXTMENU)
 643         ]
 644         void ShowContextMenu(
 645             [in] long x,
 646             [in] long y
 647         );
 648
 649         [
 650             id(DISPID_CONTEXTMENUACTION)
 651         ]
 652         void ContextMenuAction(
 653             [in] long index
 654         );
 655
 656         [
 657             id(DISPID_ONMOUSEDOWN)
 658         ]
 659         void onmousedown();
 660
 661         [
 662             id(DISPID_ONMOUSEMOVE)
 663         ]
 664         void onmousemove();
 665
 666         [
 667             id(DISPID_ONMOUSEUP)
 668         ]
 669         void onmouseup();
 670
 671         [
 672             id(DISPID_ONMOUSEOUT)
 673         ]
 674         void onmouseout();
 675
 676         [
 677             id(DISPID_ONMOUSEOVER)
 678         ]
 679         void onmouseover();
 680
 681         [
 682             id(DISPID_ONCLICK)
 683         ]
 684         void onclick();
 685
 686         [
 687             id(DISPID_ONDBLCLICK)
 688         ]
 689         void ondblclick();
 690
 691         [
 692             id(DISPID_ONKEYDOWN)
 693         ]
 694         void onkeydown();
 695
 696         [
 697             id(DISPID_ONKEYPRESS)
 698         ]
 699         void onkeypress();
 700
 701         [
 702             id(DISPID_ONKEYUP)
 703         ]
 704         void onkeyup();
 705
 706         [
 707             id(DISPID_ONBLUR)
 708         ]
 709         void onblur();
 710
 711         [
 712             id(DISPID_ONREADYSTATECHANGE)
 713         ]
 714         void onreadystatechange();
 715     };
 716
 717     [
 718         uuid(2d360200-fff5-11d1-8d03-00a0c959bc0a),
 719         threading(apartment),
 720         progid("DHTMLEdit.DHTMLEdit.1"),
 721         vi_progid("DHTMLEdit.DHTMLEdit")
 722     ]
 723     coclass DHTMLEdit
 724     {
 725         [default] interface IDHTMLEdit;
 726         [default, source] interface _DHTMLEditEvents;
 727     };
 728 }