InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ISVGExportPreferences Class Referenceabstract

#include <ISVGExportPreferences.h>

Inheritance diagram for ISVGExportPreferences:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ISVGEXPORTPREFERENCES }
 
enum  ImageFormat { kDefaultImageFormat, kJPEGImageFormat, kGIFImageFormat, kPNGImageFormat }
 
enum  JPEGQuality {
  kJPEGQualityHigh, kJPEGQualityMedHigh, kJPEGQualityMed, kJPEGQualityMedLow,
  kJPEGQualityLow
}
 
enum  GIFPaletteType {
  kWebPalette, kMacPalette, kWinPalette, kExactPalette,
  kAdaptivePalette
}
 
enum  ExportBitmapSampling { kHiResSampling, kLowResSampling }
 
enum  FontSubsetting {
  kSubsetNone, kSubsetGlyphsOnly, kSubsetCommonEnglishOnly, kSubsetGlyphsPlusEnglish,
  kSubsetCommonRomanOnly, kSubsetGlyphsPlusRoman, kSubsetEntire
}
 
enum  ImageSampling { kNoSampling, kSubSampling, kDownSampling }
 
enum  RenderingStyle { kProgressiveRendering, kBatchRendering }
 
enum  FileEncoding { kASCIIEncoding, kUTF8Encoding, kUTF16Encoding }
 
enum  StyleFormat { kInlineStyleFormat, kEntityStyleFormat, kCSSStyleFormat, kInlineFormat }
 
enum  PageRangeFormat { kAllPages, kRange }
 

Public Member Functions

virtual bool16 GetEmbedImages () const =0
 
virtual void SetEmbedImages (bool16 embed)=0
 
virtual ImageFormat GetImageFormat () const =0
 
virtual void SetImageFormat (ImageFormat format)=0
 
virtual JPEGQuality GetJPEGQuality () const =0
 
virtual void SetJPEGQuality (JPEGQuality quality)=0
 
virtual GIFPaletteType GetGIFPaletteType () const =0
 
virtual void SetGIFPaletteType (GIFPaletteType palette)=0
 
virtual bool16 GetInterlacedGIF () const =0
 
virtual void SetInterlacedGIF (bool16 interlace)=0
 
virtual ExportBitmapSampling GetExportBitmapSampling () const =0
 
virtual void SetExportBitmapSampling (ExportBitmapSampling sampling)=0
 
virtual bool16 GetEmbedFonts () const =0
 
virtual void SetEmbedFonts (bool16 embed)=0
 
virtual FontSubsetting GetFontSubsetting () const =0
 
virtual void SetFontSubsetting (FontSubsetting subset)=0
 
virtual bool16 GetOutputReadersSpreads () const =0
 
virtual void SetOutputReadersSpreads (bool16 output)=0
 
virtual ImageSampling GetImageSampling () const =0
 
virtual void SetImageSampling (ImageSampling sampling)=0
 
virtual uint32 GetRealPrecision () const =0
 
virtual void SetRealPrecision (uint32 precision)=0
 
virtual RenderingStyle GetRenderingStyle () const =0
 
virtual void SetRenderingStyle (RenderingStyle style)=0
 
virtual FileEncoding GetFileEncoding () const =0
 
virtual void SetFileEncoding (FileEncoding encoding)=0
 
virtual StyleFormat GetStyleFormat () const =0
 
virtual void SetStyleFormat (StyleFormat format)=0
 
virtual PageRangeFormat GetPageRangeFormat () const =0
 
virtual void SetPageRangeFormat (PageRangeFormat format)=0
 
virtual PMString const & GetPageRange () const =0
 
virtual void SetPageRange (PMString const &range)=0
 
virtual UID GetFlattenerStyle () const =0
 
virtual void SetFlattenerStyle (UID const &style)=0
 
virtual bool16 GetIgnoreFlattenerSpreadOverrides () const =0
 
virtual void SetIgnoreFlattenerSpreadOverrides (bool16 ignore)=0
 
virtual bool16 GetFlattenOutput () const =0
 
virtual void SetFlattenOutput (bool16 flatten)=0
 
virtual bool16 GetUseNativeXP () const =0
 
virtual void SetUseNativeXP (bool16 useNativeXP)=0
 
virtual void Copy (ISVGExportPreferences const *other)=0
 
virtual bool16 GetPageItemExport () const =0
 
virtual void SetPageItemExport (bool16 pageitemExport)=0
 
virtual void EnableDisableContent (bool16 inEnableStroke)=0
 
virtual void EnableDisableFill (bool16 inEnableFill)=0
 
virtual void EnableDisableStroke (bool16 inEnableFill)=0
 
virtual bool16 IsContentEnabled () const =0
 
virtual bool16 IsStrokeEnabled () const =0
 
virtual bool16 IsFillEnabled () const =0
 
virtual void EnableWriteXMLHeader (bool16 enable)=0
 
virtual bool16 IsWriteXMLHeaderEnabled () const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Interface defining preferences to be used when exporting to SVG

Member Enumeration Documentation

Bitmap sampling options

File encoding options

Font subsetting options

Export palette types used for GIF images

Preferred image format. Actual format used may differ if rasterization requires capabilities not found in specified format (eg. JPEG can't be used if require transparency)

Image sampling options

JPEG quality levels

SVG rendering styles

SVG Style formats

Member Function Documentation

virtual void ISVGExportPreferences::Copy (ISVGExportPreferences const * other)
pure virtual

Copies one set of prefs into another

Note: use a command to actually set this!

Parameters
otherIN The preferences to copy
virtual bool16 ISVGExportPreferences::GetEmbedFonts () const
pure virtual

Gets embed fonts flag

Returns
Embed fonts flag
virtual ExportBitmapSampling ISVGExportPreferences::GetExportBitmapSampling () const
pure virtual

Gets bitmap sampling

Returns
Bitmap sampling
virtual FileEncoding ISVGExportPreferences::GetFileEncoding () const
pure virtual

Gets file encoding option

Returns
File encoding option
virtual UID ISVGExportPreferences::GetFlattenerStyle () const
pure virtual

Gets flattener style

Returns
UID of flattener style
virtual bool16 ISVGExportPreferences::GetFlattenOutput () const
pure virtual

Gets flatten output flag

Returns
Flatten output flag
virtual FontSubsetting ISVGExportPreferences::GetFontSubsetting () const
pure virtual

Gets font subsetting option

Returns
Font subsetting option
virtual GIFPaletteType ISVGExportPreferences::GetGIFPaletteType () const
pure virtual

Gets GIF palette type

Returns
GIF palette type
virtual bool16 ISVGExportPreferences::GetIgnoreFlattenerSpreadOverrides () const
pure virtual

Gets ignore spread overrides flag

Returns
Ignore spread overrides flag
virtual ImageFormat ISVGExportPreferences::GetImageFormat () const
pure virtual

Gets preferred image format

Returns
Preferred image format
virtual ImageSampling ISVGExportPreferences::GetImageSampling () const
pure virtual

Gets image sampling option

Returns
Image sampling option
virtual bool16 ISVGExportPreferences::GetInterlacedGIF () const
pure virtual

Gets GIF interlacing

Returns
GIF interlacing setting
virtual JPEGQuality ISVGExportPreferences::GetJPEGQuality () const
pure virtual

Gets JPEG compression quality

Returns
JPEG compression quality
virtual bool16 ISVGExportPreferences::GetOutputReadersSpreads () const
pure virtual

Gets reader's spreads setting

Returns
Reader's spreads setting
virtual bool16 ISVGExportPreferences::GetPageItemExport () const
pure virtual

Gets pageitem export flag

Returns
pageitem export flag
virtual PMString const& ISVGExportPreferences::GetPageRange () const
pure virtual

Gets page range as a string

Returns
Page range string
virtual PageRangeFormat ISVGExportPreferences::GetPageRangeFormat () const
pure virtual

Gets page range format

Returns
Page range format
virtual uint32 ISVGExportPreferences::GetRealPrecision () const
pure virtual

Gets real precision

Returns
Real precision as an int between 1 and 7, inclusive
virtual RenderingStyle ISVGExportPreferences::GetRenderingStyle () const
pure virtual

Gets rendering style

Returns
Rendering style
virtual StyleFormat ISVGExportPreferences::GetStyleFormat () const
pure virtual

Gets style format

Returns
Style format
virtual bool16 ISVGExportPreferences::GetUseNativeXP () const
pure virtual

Gets use native XP flag

Returns
Use native XP flag
virtual void ISVGExportPreferences::SetEmbedFonts (bool16 embed)
pure virtual

Sets embed fonts flag

Parameters
embedIN New embed setting
virtual void ISVGExportPreferences::SetEmbedImages (bool16 embed)
pure virtual

Sets embed images flag

Parameters
embedIN If kTrue, images are embedded.
virtual void ISVGExportPreferences::SetExportBitmapSampling (ExportBitmapSampling sampling)
pure virtual

Sets bitmap sampling

Parameters
samplingIN New sampling setting
virtual void ISVGExportPreferences::SetFileEncoding (FileEncoding encoding)
pure virtual

Sets file encoding option

Parameters
encodingIN New encoding option
virtual void ISVGExportPreferences::SetFlattenerStyle (UID const & style)
pure virtual

Sets flattener style

Parameters
styleIN New flattener style UID
virtual void ISVGExportPreferences::SetFlattenOutput (bool16 flatten)
pure virtual

Sets flatten output flag

Parameters
flattenIN New flatten output flag
virtual void ISVGExportPreferences::SetFontSubsetting (FontSubsetting subset)
pure virtual

Sets font subsetting option

Parameters
subsetIN New font subsetting option
virtual void ISVGExportPreferences::SetGIFPaletteType (GIFPaletteType palette)
pure virtual

Sets GIF palette type

Parameters
paletteIN New GIF palette type
virtual void ISVGExportPreferences::SetIgnoreFlattenerSpreadOverrides (bool16 ignore)
pure virtual

Sets ignore spread overrides flag

Parameters
ignoreIN New ignore spread overrides flag
virtual void ISVGExportPreferences::SetImageFormat (ImageFormat format)
pure virtual

Sets preferred image format

Parameters
formatIN Preferred image format
virtual void ISVGExportPreferences::SetImageSampling (ImageSampling sampling)
pure virtual

Sets image sampling option

Parameters
samplingIN New sampling option
virtual void ISVGExportPreferences::SetInterlacedGIF (bool16 interlace)
pure virtual

Sets GIF interlacing

Parameters
interlaceIN New GIF interlace setting
virtual void ISVGExportPreferences::SetJPEGQuality (JPEGQuality quality)
pure virtual

Sets JPEG compression quality

Parameters
qualityIN New compression quality
virtual void ISVGExportPreferences::SetOutputReadersSpreads (bool16 output)
pure virtual

Sets reader's spreads setting

Parameters
outputIN New reader's spreads setting
virtual void ISVGExportPreferences::SetPageItemExport (bool16 pageitemExport)
pure virtual

Sets pageitem export flag

Parameters
pageitemExportIN New pageitem export flag
virtual void ISVGExportPreferences::SetPageRange (PMString const & range)
pure virtual

Sets page range as a string

Parameters
rangeIN New page range string
virtual void ISVGExportPreferences::SetPageRangeFormat (PageRangeFormat format)
pure virtual

Sets page range format

Parameters
formatIN New page range format
virtual void ISVGExportPreferences::SetRealPrecision (uint32 precision)
pure virtual

Sets real precision. Must be between 1 and 7, inclusive

Parameters
precisionIN New real precision
virtual void ISVGExportPreferences::SetRenderingStyle (RenderingStyle style)
pure virtual

Sets rendering style

Parameters
styleIN New rendering style
virtual void ISVGExportPreferences::SetStyleFormat (StyleFormat format)
pure virtual

Sets style format

Parameters
formatIN New style format
virtual void ISVGExportPreferences::SetUseNativeXP (bool16 useNativeXP)
pure virtual

Sets use native XP flag

Parameters
useNativeXPIN New use native XP flag