include/xpsobjectmodel.idl

   1 /*
   2  * Copyright 2021 Nikolay Sivov for CodeWeavers
   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 "msopc.idl";
  20
  21 interface IXpsOMPrintTicketResource;
  22 interface IXpsOMDocumentStructureResource;
  23 interface IXpsOMSignatureBlockResourceCollection;
  24 interface IXpsOMPartUriCollection;
  25 interface IXpsOMPage;
  26 interface IXpsOMStoryFragmentsResource;
  27 interface IXpsOMImageResource;
  28 interface IXpsOMResource;
  29 interface IXpsOMObjectFactory;
  30 interface IXpsOMSignatureBlockResource;
  31 interface IXpsOMDictionary;
  32 interface IXpsOMRemoteDictionaryResource;
  33 interface IXpsOMPartResources;
  34 interface IXpsOMDocument;
  35 interface IXpsOMPageReference;
  36 interface IXpsOMCanvas;
  37 interface IXpsOMFontResource;
  38 interface IXpsOMGlyphs;
  39 interface IXpsOMPath;
  40 interface IXpsOMGeometry;
  41 interface IXpsOMGeometryFigure;
  42 interface IXpsOMMatrixTransform;
  43 interface IXpsOMColorProfileResource;
  44 interface IXpsOMSolidColorBrush;
  45 interface IXpsOMImageBrush;
  46 interface IXpsOMVisualBrush;
  47 interface IXpsOMGradientStop;
  48 interface IXpsOMLinearGradientBrush;
  49 interface IXpsOMRadialGradientBrush;
  50 interface IXpsOMCoreProperties;
  51 interface IXpsOMPackageWriter;
  52 interface IXpsOMPackage;
  53
  54 typedef [v1_enum] enum
  55 {
  56     XPS_COLOR_TYPE_SRGB = 1,
  57     XPS_COLOR_TYPE_SCRGB,
  58     XPS_COLOR_TYPE_CONTEXT
  59 } XPS_COLOR_TYPE;
  60
  61 typedef [v1_enum] enum
  62 {
  63     XPS_IMAGE_TYPE_JPEG = 1,
  64     XPS_IMAGE_TYPE_PNG,
  65     XPS_IMAGE_TYPE_TIFF,
  66     XPS_IMAGE_TYPE_WDP,
  67     XPS_IMAGE_TYPE_JXR
  68 } XPS_IMAGE_TYPE;
  69
  70 typedef [v1_enum] enum
  71 {
  72     XPS_FONT_EMBEDDING_NORMAL = 1,
  73     XPS_FONT_EMBEDDING_OBFUSCATED,
  74     XPS_FONT_EMBEDDING_RESTRICTED,
  75     XPS_FONT_EMBEDDING_RESTRICTED_UNOBFUSCATED
  76 } XPS_FONT_EMBEDDING;
  77
  78 typedef [v1_enum] enum
  79 {
  80     XPS_INTERLEAVING_OFF = 1,
  81     XPS_INTERLEAVING_ON,
  82 } XPS_INTERLEAVING;
  83
  84 typedef struct
  85 {
  86     FLOAT width;
  87     FLOAT height;
  88 } XPS_SIZE;
  89
  90 typedef struct
  91 {
  92     FLOAT x;
  93     FLOAT y;
  94 } XPS_POINT;
  95
  96 typedef struct
  97 {
  98     FLOAT x;
  99     FLOAT y;
 100     FLOAT width;
 101     FLOAT height;
 102 } XPS_RECT;
 103
 104 typedef struct
 105 {
 106     FLOAT m11;
 107     FLOAT m12;
 108     FLOAT m21;
 109     FLOAT m22;
 110     FLOAT m31;
 111     FLOAT m32;
 112 } XPS_MATRIX;
 113
 114 typedef union switch (XPS_COLOR_TYPE colorType) value
 115 {
 116     case XPS_COLOR_TYPE_SRGB:
 117         struct
 118         {
 119             UINT8 alpha, red, green, blue;
 120         } sRGB;
 121     case XPS_COLOR_TYPE_SCRGB:
 122         struct
 123         {
 124             FLOAT alpha, red, green, blue;
 125         } scRGB;
 126     case XPS_COLOR_TYPE_CONTEXT:
 127         struct
 128         {
 129             UINT8 channelCount;
 130             FLOAT channels[9];
 131         } context;
 132 } XPS_COLOR;
 133
 134 [
 135     object,
 136     uuid(74eb2f0b-a91e-4486-afac-0fabeca3dfc6)
 137 ]
 138 interface IXpsOMPart : IUnknown
 139 {
 140     HRESULT GetPartName(
 141         [out, retval] IOpcPartUri **partUri
 142     );
 143
 144     HRESULT SetPartName(
 145         [in] IOpcPartUri *partUri
 146     );
 147 }
 148
 149 [
 150     object,
 151     pointer_default(ref),
 152     uuid(d1c87f0d-e947-4754-8a25-971478f7e83e)
 153 ]
 154 interface IXpsOMDocumentCollection : IUnknown
 155 {
 156     HRESULT GetCount(
 157         [out, retval] UINT32 *count
 158     );
 159
 160     HRESULT GetAt(
 161         [in] UINT32 index,
 162         [out, retval] IXpsOMDocument **document
 163     );
 164
 165     HRESULT InsertAt(
 166         [in] UINT32 index,
 167         [in] IXpsOMDocument *document
 168     );
 169
 170     HRESULT RemoveAt(
 171         [in] UINT32 index
 172     );
 173
 174     HRESULT SetAt(
 175         [in] UINT32 index,
 176         [in] IXpsOMDocument *document
 177     );
 178
 179     HRESULT Append(
 180         [in] IXpsOMDocument *document
 181     );
 182 }
 183
 184 [
 185     object,
 186     pointer_default(ref),
 187     uuid(56492eb4-d8d5-425e-8256-4c2b64ad0264)
 188 ]
 189 interface IXpsOMDocumentSequence : IXpsOMPart
 190 {
 191     HRESULT GetOwner(
 192         [out, retval] IXpsOMPackage **package
 193     );
 194
 195     HRESULT GetDocuments(
 196         [out, retval] IXpsOMDocumentCollection **documents
 197     );
 198
 199     HRESULT GetPrintTicketResource(
 200         [out, retval] IXpsOMPrintTicketResource **printTicketResource
 201     );
 202
 203     HRESULT SetPrintTicketResource(
 204         [in] IXpsOMPrintTicketResource *printTicketResource
 205     );
 206 }
 207
 208 [
 209     object,
 210     local,
 211     pointer_default(ref),
 212     uuid(18c3df65-81e1-4674-91dc-fc452f5a416f)
 213 ]
 214 interface IXpsOMPackage : IUnknown
 215 {
 216     HRESULT GetDocumentSequence(
 217         [out, retval] IXpsOMDocumentSequence **documentSequence
 218     );
 219
 220     HRESULT SetDocumentSequence(
 221         [in] IXpsOMDocumentSequence *documentSequence
 222     );
 223
 224     HRESULT GetCoreProperties(
 225         [out, retval] IXpsOMCoreProperties **coreProperties
 226     );
 227
 228     HRESULT SetCoreProperties(
 229         [in] IXpsOMCoreProperties *coreProperties
 230     );
 231
 232     HRESULT GetDiscardControlPartName(
 233         [out, retval] IOpcPartUri **discardControlPartUri
 234     );
 235
 236     HRESULT SetDiscardControlPartName(
 237         [in] IOpcPartUri *discardControlPartUri
 238     );
 239
 240     HRESULT GetThumbnailResource(
 241         [out, retval] IXpsOMImageResource **imageResource
 242     );
 243
 244     HRESULT SetThumbnailResource(
 245         [in] IXpsOMImageResource *imageResource
 246     );
 247
 248     HRESULT WriteToFile(
 249         [in, string] LPCWSTR fileName,
 250         [in, unique] LPSECURITY_ATTRIBUTES securityAttributes,
 251         [in] DWORD flagsAndAttributes,
 252         [in] BOOL optimizeMarkupSize
 253     );
 254
 255     HRESULT WriteToStream(
 256         [in] ISequentialStream *stream,
 257         [in] BOOL optimizeMarkupSize
 258     );
 259 }
 260
 261 [
 262     object,
 263     local,
 264     pointer_default(ref),
 265     uuid(f9b2a685-a50d-4fc2-b764-b56e093ea0ca),
 266 ]
 267 interface IXpsOMObjectFactory : IUnknown
 268 {
 269     HRESULT CreatePackage(
 270         [out, retval] IXpsOMPackage **package
 271     );
 272
 273     HRESULT CreatePackageFromFile(
 274         [in, string] LPCWSTR filename,
 275         [in] BOOL reuseObjects,
 276         [out, retval] IXpsOMPackage **package
 277     );
 278
 279     HRESULT CreatePackageFromStream(
 280         [in] IStream *stream,
 281         [in] BOOL reuseObjects,
 282         [out, retval] IXpsOMPackage **package
 283     );
 284
 285     HRESULT CreateStoryFragmentsResource(
 286         [in] IStream *acquiredStream,
 287         [in] IOpcPartUri *partUri,
 288         [out, retval] IXpsOMStoryFragmentsResource **storyFragmentsResource
 289     );
 290
 291     HRESULT CreateDocumentStructureResource(
 292         [in] IStream *acquiredStream,
 293         [in] IOpcPartUri *partUri,
 294         [out, retval] IXpsOMDocumentStructureResource **documentStructureResource
 295     );
 296
 297     HRESULT CreateSignatureBlockResource(
 298         [in] IStream *acquiredStream,
 299         [in] IOpcPartUri *partUri,
 300         [out, retval] IXpsOMSignatureBlockResource **signatureBlockResource
 301     );
 302
 303     HRESULT CreateRemoteDictionaryResource(
 304         [in] IXpsOMDictionary *dictionary,
 305         [in] IOpcPartUri *partUri,
 306         [out, retval] IXpsOMRemoteDictionaryResource **remoteDictionaryResource
 307     );
 308
 309     HRESULT CreateRemoteDictionaryResourceFromStream(
 310         [in] IStream *dictionaryMarkupStream,
 311         [in] IOpcPartUri *dictionaryPartUri,
 312         [in] IXpsOMPartResources *resources,
 313         [out, retval] IXpsOMRemoteDictionaryResource **dictionaryResource
 314     );
 315
 316     HRESULT CreatePartResources(
 317         [out, retval] IXpsOMPartResources **partResources
 318     );
 319
 320     HRESULT CreateDocumentSequence(
 321         [in] IOpcPartUri *partUri,
 322         [out, retval] IXpsOMDocumentSequence **documentSequence
 323     );
 324
 325     HRESULT CreateDocument(
 326         [in] IOpcPartUri *partUri,
 327         [out, retval] IXpsOMDocument **document
 328     );
 329
 330     HRESULT CreatePageReference(
 331         [in] const XPS_SIZE *advisoryPageDimensions,
 332         [out, retval] IXpsOMPageReference **pageReference
 333     );
 334
 335     HRESULT CreatePage(
 336         [in] const XPS_SIZE *pageDimensions,
 337         [in, string] LPCWSTR language,
 338         [in] IOpcPartUri *partUri,
 339         [out, retval] IXpsOMPage **page
 340     );
 341
 342     HRESULT CreatePageFromStream(
 343         [in] IStream *pageMarkupStream,
 344         [in] IOpcPartUri *partUri,
 345         [in] IXpsOMPartResources *resources,
 346         [in] BOOL reuseObjects,
 347         [out, retval] IXpsOMPage **page
 348     );
 349
 350     HRESULT CreateCanvas(
 351         [out, retval] IXpsOMCanvas **canvas
 352     );
 353
 354     HRESULT CreateGlyphs(
 355         [in] IXpsOMFontResource *fontResource,
 356         [out, retval] IXpsOMGlyphs **glyphs
 357     );
 358
 359     HRESULT CreatePath(
 360         [out, retval] IXpsOMPath **path
 361     );
 362
 363     HRESULT CreateGeometry(
 364         [out, retval] IXpsOMGeometry **geometry
 365     );
 366
 367     HRESULT CreateGeometryFigure(
 368         [in] const XPS_POINT *startPoint,
 369         [out, retval] IXpsOMGeometryFigure **figure
 370     );
 371
 372     HRESULT CreateMatrixTransform(
 373         [in]  const XPS_MATRIX *matrix,
 374         [out, retval] IXpsOMMatrixTransform **transform
 375     );
 376
 377     HRESULT CreateSolidColorBrush(
 378         [in] const XPS_COLOR *color,
 379         [in] IXpsOMColorProfileResource *colorProfile,
 380         [out, retval] IXpsOMSolidColorBrush **solidColorBrush
 381     );
 382
 383     HRESULT CreateColorProfileResource(
 384         [in] IStream *acquiredStream,
 385         [in] IOpcPartUri *partUri,
 386         [out, retval] IXpsOMColorProfileResource **colorProfileResource
 387     );
 388
 389     HRESULT CreateImageBrush(
 390         [in] IXpsOMImageResource *image,
 391         [in] const XPS_RECT *viewBox,
 392         [in] const XPS_RECT *viewPort,
 393         [out, retval] IXpsOMImageBrush **imageBrush
 394     );
 395
 396     HRESULT CreateVisualBrush(
 397         [in] const XPS_RECT *viewBox,
 398         [in] const XPS_RECT *viewPort,
 399         [out, retval] IXpsOMVisualBrush **visualBrush
 400     );
 401
 402     HRESULT CreateImageResource(
 403         [in] IStream *acquiredStream,
 404         [in] XPS_IMAGE_TYPE contentType,
 405         [in] IOpcPartUri *partUri,
 406         [out, retval] IXpsOMImageResource **imageResource
 407     );
 408
 409     HRESULT CreatePrintTicketResource(
 410         [in] IStream *acquiredStream,
 411         [in] IOpcPartUri *partUri,
 412         [out, retval] IXpsOMPrintTicketResource **printTicketResource
 413     );
 414
 415     HRESULT CreateFontResource(
 416         [in] IStream *acquiredStream,
 417         [in] XPS_FONT_EMBEDDING fontEmbedding,
 418         [in] IOpcPartUri *partUri,
 419         [in] BOOL isObfSourceStream,
 420         [out, retval] IXpsOMFontResource **fontResource
 421     );
 422
 423     HRESULT CreateGradientStop(
 424         [in] const XPS_COLOR *color,
 425         [in] IXpsOMColorProfileResource *colorProfile,
 426         [in] FLOAT offset,
 427         [out, retval] IXpsOMGradientStop **gradientStop
 428     );
 429
 430     HRESULT CreateLinearGradientBrush(
 431         [in] IXpsOMGradientStop *gradStop1,
 432         [in] IXpsOMGradientStop *gradStop2,
 433         [in] const XPS_POINT *startPoint,
 434         [in] const XPS_POINT *endPoint,
 435         [out, retval] IXpsOMLinearGradientBrush **linearGradientBrush
 436     );
 437
 438     HRESULT CreateRadialGradientBrush
 439     (
 440         [in] IXpsOMGradientStop *gradStop1,
 441         [in] IXpsOMGradientStop *gradStop2,
 442         [in] const XPS_POINT *centerPoint,
 443         [in] const XPS_POINT *gradientOrigin,
 444         [in] const XPS_SIZE *radiiSizes,
 445         [out, retval] IXpsOMRadialGradientBrush **radialGradientBrush
 446     );
 447
 448     HRESULT CreateCoreProperties(
 449         [in] IOpcPartUri *partUri,
 450         [out, retval] IXpsOMCoreProperties **coreProperties
 451     );
 452
 453     HRESULT CreateDictionary(
 454         [out, retval] IXpsOMDictionary **dictionary
 455     );
 456
 457     HRESULT CreatePartUriCollection(
 458         [out, retval] IXpsOMPartUriCollection **partUriCollection
 459     );
 460
 461     HRESULT CreatePackageWriterOnFile(
 462         [in, string] LPCWSTR fileName,
 463         [in, unique] LPSECURITY_ATTRIBUTES securityAttributes,
 464         [in] DWORD flagsAndAttributes,
 465         [in] BOOL optimizeMarkupSize,
 466         [in] XPS_INTERLEAVING interleaving,
 467         [in] IOpcPartUri *documentSequencePartName,
 468         [in] IXpsOMCoreProperties *coreProperties,
 469         [in] IXpsOMImageResource *packageThumbnail,
 470         [in] IXpsOMPrintTicketResource *documentSequencePrintTicket,
 471         [in] IOpcPartUri *discardControlPartName,
 472         [out, retval] IXpsOMPackageWriter **packageWriter
 473     );
 474
 475     HRESULT CreatePackageWriterOnStream
 476     (
 477         [in] ISequentialStream *outputStream,
 478         [in] BOOL optimizeMarkupSize,
 479         [in] XPS_INTERLEAVING interleaving,
 480         [in] IOpcPartUri *documentSequencePartName,
 481         [in] IXpsOMCoreProperties *coreProperties,
 482         [in] IXpsOMImageResource *packageThumbnail,
 483         [in] IXpsOMPrintTicketResource *documentSequencePrintTicket,
 484         [in] IOpcPartUri *discardControlPartName,
 485         [out, retval] IXpsOMPackageWriter **packageWriter
 486     );
 487
 488     HRESULT CreatePartUri(
 489         [in, string] LPCWSTR uri,
 490         [out, retval] IOpcPartUri **partUri
 491     );
 492
 493     HRESULT CreateReadOnlyStreamOnFile(
 494         [in, string] LPCWSTR filename,
 495         [out, retval] IStream **stream
 496     );
 497 }
 498
 499 [
 500     object,
 501     uuid(4e2aa182-a443-42c6-b41b-4f8e9de73ff9)
 502 ]
 503 interface IXpsOMPackageWriter : IUnknown
 504 {
 505     HRESULT StartNewDocument(
 506         [in] IOpcPartUri *documentPartName,
 507         [in] IXpsOMPrintTicketResource *documentPrintTicket,
 508         [in] IXpsOMDocumentStructureResource *documentStructure,
 509         [in] IXpsOMSignatureBlockResourceCollection *signatureBlockResources,
 510         [in] IXpsOMPartUriCollection *restrictedFonts
 511     );
 512
 513     HRESULT AddPage(
 514         [in] IXpsOMPage *page,
 515         [in] const XPS_SIZE *advisoryPageDimensions,
 516         [in] IXpsOMPartUriCollection *discardableResourceParts,
 517         [in] IXpsOMStoryFragmentsResource *storyFragments,
 518         [in] IXpsOMPrintTicketResource *pagePrintTicket,
 519         [in] IXpsOMImageResource *pageThumbnail
 520     );
 521
 522     HRESULT AddResource(
 523         [in] IXpsOMResource *resource
 524     );
 525
 526     HRESULT Close();
 527
 528     HRESULT IsClosed(
 529         [out, retval] BOOL *isClosed
 530     );
 531 }
 532
 533 [
 534     uuid(b47491a0-cf33-4fe4-9a48-b0acdae207e8)
 535 ]
 536 library MSXPS
 537 {
 538 [
 539     uuid(e974d26d-3d9b-4d47-88cc-3872f2dc3585)
 540 ]
 541 coclass XpsOMObjectFactory
 542 {
 543     interface IXpsOMObjectFactory;
 544 }
 545
 546 }