Mako 8.2.0 API
MakoCore SDK API Documentation
Loading...
Searching...
No Matches
xpsoutput.h
Go to the documentation of this file.
1/*
2* Copyright (C) 2013-2025 Global Graphics Software Ltd. All rights reserved.
3*/
4
5#ifndef JAWSMAKO_XPSOUTPUT_H
6#define JAWSMAKO_XPSOUTPUT_H
7
12
13#include <jawsmako/jawsmako.h>
14#include <jawsmako/transforms.h>
15
16namespace JawsMako
17{
18 using namespace EDL;
19
20 class IXPSOutput;
22
23 class IOXPSOutput;
25
31 class IXPSOutput : public IOutput
32 {
33 public:
34 virtual ~IXPSOutput() {}
35
43 JAWSMAKO_API static IXPSOutputPtr create(const IJawsMakoPtr &jawsMako, const IProgressMonitorPtr &progressMonitor = IProgressMonitorPtr ());
44
45 /*
46 * XPS Output-specific configuration
47 */
48
61 virtual void setCopyExistingXPSPartsWherePossible(bool copy) = 0;
62
73 virtual void setSubsetFonts(bool subset) = 0;
74
91 virtual void setMergeFonts(bool merge) = 0;
92
100 virtual void setMergeImages(bool merge = true) = 0;
101
119 virtual void setRenameFonts(bool rename = true) = 0;
120
137
154
172
181 virtual void setTargetColorSpace(const IDOMColorSpacePtr &targetSpace) = 0;
182
191 virtual void setTargetProfile(const IDOMICCProfilePtr &profile) = 0;
192
200 virtual void applyColorConverterTransform(const IColorConverterTransformPtr &transform) = 0;
201
211 virtual void setRenderResolution(uint32 resolution) = 0;
212
220 virtual void applyRendererTransform(const IRendererTransformPtr &transform) = 0;
221
236
251
267
275 virtual void setJPEGQuality(uint8 quality) = 0;
276
284 virtual void applyEncoderTransform(const IImageEncoderTransformPtr &transform) = 0;
285
302 virtual void setAlwaysUseVisualBrushesForMaskedBrushes(bool useVisual) = 0;
303
304 };
305 #define obj2IXPSOutput(obj) IXPSOutputPtr(dynamic_cast<IXPSOutput *>((IRCObject *) obj), true)
306
312 class IOXPSOutput : public IXPSOutput
313 {
314 public:
315 virtual ~IOXPSOutput() {}
316
324 JAWSMAKO_API static IXPSOutputPtr create(const IJawsMakoPtr &jawsMako, const IProgressMonitorPtr &progressMonitor = IProgressMonitorPtr());
325 };
326 #define obj2IOXPSOutput(obj) IOXPSOutputPtr(dynamic_cast<IOXPSOutput *>((IRCObject *) obj), true)
327}
328
329#endif
eDownsamplingMethod
The type of downsampling to be performed.
Definition idomimageresource.h:1937
@ eBicubic
Definition idomimageresource.h:1940
@ eSubsample
Definition idomimageresource.h:1938
eEncodeFormat
Available target image formats.
Definition transforms.h:397
Interface for the OpenXPS IOutput class.
Definition xpsoutput.h:313
static JAWSMAKO_API IXPSOutputPtr create(const IJawsMakoPtr &jawsMako, const IProgressMonitorPtr &progressMonitor=IProgressMonitorPtr())
Create an OpenXPS Output instance.
virtual ~IOXPSOutput()
Definition xpsoutput.h:315
Abstract output sink that can output DOM to a file or stream in a given output format.
Definition jawsmako.h:600
Interface for the XPS IOutput class.
Definition xpsoutput.h:32
static JAWSMAKO_API IXPSOutputPtr create(const IJawsMakoPtr &jawsMako, const IProgressMonitorPtr &progressMonitor=IProgressMonitorPtr())
Create an XPS Output instance.
virtual void setPreferredGrayImageFormat(IImageEncoderTransform::eEncodeFormat format)=0
Set the desired image format for gray images that need to be re-encoded for XPS output....
virtual void setRenderResolution(uint32 resolution)=0
Set the resolution to use if page content requires rendering in order to be output as XPS....
virtual void applyEncoderTransform(const IImageEncoderTransformPtr &transform)=0
Apply the given image encoder transform to the contents before writing to XPS. This supersedes the im...
virtual void setSubsetFonts(bool subset)=0
Set whether fonts should be subset in the output.
virtual void setCopyExistingXPSPartsWherePossible(bool copy)=0
Set whether entire XPS parts should be copied from the original assembly source when writing that ass...
virtual void applyColorConverterTransform(const IColorConverterTransformPtr &transform)=0
Apply the given color converter transform to the contents before writing to XPS. This supersedes the ...
virtual void setColorImageMaxResolution(float resolution, float threshold=0.0f, IDOMImageDownsamplerFilter::eDownsamplingMethod method=IDOMImageDownsamplerFilter::eBicubic)=0
Set the desired maximum resolution, threshold and downsampling method for color images.
virtual void setPreferredColorImageFormat(IImageEncoderTransform::eEncodeFormat format)=0
Set the desired image format for color images that need to be re-encoded for XPS output....
virtual void setJPEGQuality(uint8 quality)=0
Set the JPEG quality to use when encoding images in JPEG format. Equivalent to calling setParameter()...
virtual void setMonoImageMaxResolution(float resolution, float threshold=0.0f, IDOMImageDownsamplerFilter::eDownsamplingMethod method=IDOMImageDownsamplerFilter::eSubsample)=0
Set the desired maximum resolution, threshold and downsampling method for monochrome images.
virtual void setMergeFonts(bool merge)=0
Set whether an attempt will be made to merge disparate subsets of a font into a single font.
virtual void setTargetColorSpace(const IDOMColorSpacePtr &targetSpace)=0
Set the target color space for the output. The default behaviour is to, where possible,...
virtual void setPreferredMonoImageFormat(IImageEncoderTransform::eEncodeFormat format)=0
Set the desired image format for monochrome images that need to be re-encoded for XPS output....
virtual void setMergeImages(bool merge=true)=0
Set if the XPS output should attempt to merge adjacent images. Equivalent to calling setParameter wit...
virtual void setAlwaysUseVisualBrushesForMaskedBrushes(bool useVisual)=0
Set whether to use equivalent XPS Visual brushes for certain types of IDOMMaskedBrush brushes to work...
virtual void applyRendererTransform(const IRendererTransformPtr &transform)=0
Apply the given renderer transform to the contents before writing to XPS. This supersedes the target ...
virtual void setTargetProfile(const IDOMICCProfilePtr &profile)=0
Set the target color space for the output using an ICC profile. The default behaviour is to,...
virtual void setRenameFonts(bool rename=true)=0
Set if the XPS output should rename fonts to aid with problematic print environments.
virtual ~IXPSOutput()
Definition xpsoutput.h:34
virtual void setGrayImageMaxResolution(float resolution, float threshold=0.0f, IDOMImageDownsamplerFilter::eDownsamplingMethod method=IDOMImageDownsamplerFilter::eBicubic)=0
Set the desired maximum resolution, threshold and downsampling method for gray images.
unsigned int uint32
Definition edltypes.h:34
unsigned char uint8
Definition edltypes.h:32
Definition apexcustompostprocess.h:17
EDL::IProgressMonitorPtr IProgressMonitorPtr
Definition types.h:85
#define DECL_SMART_PTR(cls)
Definition smartptr.h:211
Transforms for JawsMako, allowing direct modification of individual brushes, nodes,...
#define JAWSMAKO_API
Definition types.h:29