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

#include <ISnapPrefsData.h>

Inheritance diagram for ISnapPrefsData:
IPMUnknownCPMUnknown< ISnapPrefsData >SnapPrefsDataSnapPrefsDataPersist

Public Types

enum  { kDefaultIID = IID_ISNAPPREFSDATA }
 

Public Member Functions

virtual void CopyPrefs (ISnapPrefsData *prefsToCopy)=0
 
virtual void SetName (const WideString &name)=0
 
virtual const WideStringGetName ()=0
 
virtual void SetFormatClassID (const ClassID &formatClassID)=0
 
virtual const ClassIDGetFormatClassID ()=0
 
virtual void SetScale (const PMReal &scale)=0
 
virtual const PMRealGetScale ()=0
 
virtual void SetResolution (const PMReal &resolution)=0
 
virtual const PMRealGetResolution ()=0
 
virtual void SetMinimumResolution (const PMReal &minimumResolution)=0
 
virtual const PMRealGetMinimumResolution ()=0
 
virtual void SetBleed (const PMReal &bleed)=0
 
virtual const PMRealGetBleed ()=0
 
virtual void SetDrawArea (bool16 drawArea)=0
 
virtual const bool16 & GetDrawArea ()=0
 
virtual void SetFullResolutionGraphics (bool16 fullResolutionGraphics)=0
 
virtual const bool16 & GetFullResolutionGraphics ()=0
 
virtual void SetDrawGray (bool16 drawGray)=0
 
virtual const bool16 & GetDrawGray ()=0
 
virtual void SetDrawingFlags (int32 drawingFlags)=0
 
virtual const int32 & GetDrawingFlags ()=0
 
virtual void SetJPEGEncoding (const int32 encoding)=0
 
virtual const int32 & GetJPEGEncoding ()=0
 
virtual void SetJPEGQuality (const int32 quality)=0
 
virtual const int32 & GetJPEGQuality ()=0
 
virtual void SetTIFFPaletteType (const int32 paletteType)=0
 
virtual const int32 & GetTIFFPaletteType ()=0
 
virtual void SetGIFPaletteType (const int32 paletteType)=0
 
virtual const int32 & GetGIFPaletteType ()=0
 
virtual void SetTIFFTransparent (const bool16 transparent)=0
 
virtual const bool16 & GetTIFFTransparent ()=0
 
virtual void SetGIFTransparent (const bool16 transparent)=0
 
virtual const bool16 & GetGIFTransparent ()=0
 
virtual void SetGIFInterlaced (const bool16 interlaced)=0
 
virtual const bool16 & GetGIFInterlaced ()=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

From SDK sample; interface for SnapShot preferences data.

Member Function Documentation

virtual void ISnapPrefsData::CopyPrefs (ISnapPrefsDataprefsToCopy)
pure virtual

Copy the given ISnapPrefsData to here. This is a shortcut if you only want to change one setting, use this to copy the settings then just change the one.

Parameters
prefsToCopyIN the ISnapPrefsData to copy

Implemented in SnapPrefsDataPersist, and SnapPrefsData.

virtual const PMReal& ISnapPrefsData::GetBleed ()
pure virtual

Get the bleed.

Implemented in SnapPrefsData, and SnapPrefsDataPersist.

virtual const bool16& ISnapPrefsData::GetDrawArea ()
pure virtual

Returns kTrue if draw the clicked spread, returns kFalse if draw the selected items.

Implemented in SnapPrefsData, and SnapPrefsDataPersist.

virtual const bool16& ISnapPrefsData::GetDrawGray ()
pure virtual

Returns kTrue if image is draw in grayscale, otherwise returns kFalse.

Implemented in SnapPrefsData, and SnapPrefsDataPersist.

virtual const int32& ISnapPrefsData::GetDrawingFlags ()
pure virtual

Get the drawing flag.

Implemented in SnapPrefsData, and SnapPrefsDataPersist.

virtual const ClassID& ISnapPrefsData::GetFormatClassID ()
pure virtual

Get the image write format class ID.

Implemented in SnapPrefsDataPersist, and SnapPrefsData.

virtual const bool16& ISnapPrefsData::GetFullResolutionGraphics ()
pure virtual

Returns kTrue if the image is drawn at full resolution, otherwise returns kFalse.

Implemented in SnapPrefsData, and SnapPrefsDataPersist.

virtual const bool16& ISnapPrefsData::GetGIFInterlaced ()
pure virtual

Get the interlace flag for GIF image.

Implemented in SnapPrefsData, and SnapPrefsDataPersist.

virtual const int32& ISnapPrefsData::GetGIFPaletteType ()
pure virtual

Get the palette type for GIF image.

Implemented in SnapPrefsData, and SnapPrefsDataPersist.

virtual const bool16& ISnapPrefsData::GetGIFTransparent ()
pure virtual

Get the transparency flag for GIF image.

Implemented in SnapPrefsData, and SnapPrefsDataPersist.

virtual const int32& ISnapPrefsData::GetJPEGEncoding ()
pure virtual

Get the JPEG encoding.

Implemented in SnapPrefsData, and SnapPrefsDataPersist.

virtual const int32& ISnapPrefsData::GetJPEGQuality ()
pure virtual

Get JPEG quality.

Implemented in SnapPrefsData, and SnapPrefsDataPersist.

virtual const PMReal& ISnapPrefsData::GetMinimumResolution ()
pure virtual

Get the minimum image resolution.

Implemented in SnapPrefsData, and SnapPrefsDataPersist.

virtual const WideString& ISnapPrefsData::GetName ()
pure virtual

Get the file name.

Implemented in SnapPrefsDataPersist, and SnapPrefsData.

virtual const PMReal& ISnapPrefsData::GetResolution ()
pure virtual

Get the image resolution.

Implemented in SnapPrefsData, and SnapPrefsDataPersist.

virtual const PMReal& ISnapPrefsData::GetScale ()
pure virtual

Get the x and y scale factor.

Implemented in SnapPrefsDataPersist, and SnapPrefsData.

virtual const int32& ISnapPrefsData::GetTIFFPaletteType ()
pure virtual

Get the palette type for TIFF image.

Implemented in SnapPrefsData, and SnapPrefsDataPersist.

virtual const bool16& ISnapPrefsData::GetTIFFTransparent ()
pure virtual

Get the transparency flag for TIFF image.

Implemented in SnapPrefsData, and SnapPrefsDataPersist.

virtual void ISnapPrefsData::SetBleed (const PMRealbleed)
pure virtual

Set the bounds of the area to be drawn by the given amount of bleed.

Implemented in SnapPrefsData, and SnapPrefsDataPersist.

virtual void ISnapPrefsData::SetDrawArea (bool16 drawArea)
pure virtual

Set the draw area, the spread that is clicked or the selected items.

Implemented in SnapPrefsData, and SnapPrefsDataPersist.

virtual void ISnapPrefsData::SetDrawGray (bool16 drawGray)
pure virtual

Set to kTrue to draw grayscale, otherwise draw RGB.

Implemented in SnapPrefsData, and SnapPrefsDataPersist.

virtual void ISnapPrefsData::SetDrawingFlags (int32 drawingFlags)
pure virtual

Set the drawing flag.

Parameters
drawingFlagsIN If this is set to kPrinting, then it suppresses the drawing of margins and guides. See IShape for the drawing flags.
See Also
IShape

Implemented in SnapPrefsData, and SnapPrefsDataPersist.

virtual void ISnapPrefsData::SetFormatClassID (const ClassIDformatClassID)
pure virtual

Set the image write format class ID.

Implemented in SnapPrefsDataPersist, and SnapPrefsData.

virtual void ISnapPrefsData::SetFullResolutionGraphics (bool16 fullResolutionGraphics)
pure virtual

Set to kTrue to force images and graphics to draw at full resolution, otherwise draw proxies.

Implemented in SnapPrefsData, and SnapPrefsDataPersist.

virtual void ISnapPrefsData::SetGIFInterlaced (const bool16 interlaced)
pure virtual

Set the interlace flag for GIF image. In general, it causes the reader to take longer to display the image if it is set.

Implemented in SnapPrefsData, and SnapPrefsDataPersist.

virtual void ISnapPrefsData::SetGIFPaletteType (const int32 paletteType)
pure virtual

Set the palette type for GIF image:

Parameters
paletteTypeSet to kTryExactThenAdaptivePalette (0), kMacPalette (1), kWebPalette (2) or kWinPalette (4). NOTE: kNoPalette is not an option for GIF images as they need a color palette.

Implemented in SnapPrefsData, and SnapPrefsDataPersist.

virtual void ISnapPrefsData::SetGIFTransparent (const bool16 transparent)
pure virtual

Set the transparency flag for GIF image.

Implemented in SnapPrefsData, and SnapPrefsDataPersist.

virtual void ISnapPrefsData::SetJPEGEncoding (const int32 encoding)
pure virtual

Set the JPEG encoding

Parameters
encodingIN Set to baseline (0) or progressive (1).

Implemented in SnapPrefsData, and SnapPrefsDataPersist.

virtual void ISnapPrefsData::SetJPEGQuality (const int32 quality)
pure virtual

Set the JPEG quality: low, good, excellent and great.

Implemented in SnapPrefsData, and SnapPrefsDataPersist.

virtual void ISnapPrefsData::SetMinimumResolution (const PMRealminimumResolution)
pure virtual

Set the minimum image resolution.

Implemented in SnapPrefsData, and SnapPrefsDataPersist.

virtual void ISnapPrefsData::SetName (const WideStringname)
pure virtual

Set the file name to which you want your snap shot saved.

Implemented in SnapPrefsDataPersist, and SnapPrefsData.

virtual void ISnapPrefsData::SetResolution (const PMRealresolution)
pure virtual

Set the image resolution.

Implemented in SnapPrefsData, and SnapPrefsDataPersist.

virtual void ISnapPrefsData::SetScale (const PMRealscale)
pure virtual

Set the x and y scale factor.

Implemented in SnapPrefsDataPersist, and SnapPrefsData.

virtual void ISnapPrefsData::SetTIFFPaletteType (const int32 paletteType)
pure virtual

Set the palette type for TIFF image.

Parameters
paletteTypeIN Set to kNoPalette (0), kTryExactThenAdaptivePalette (1), kMacPalette (2), kWebPalette (3) or kWinPalette (4).

Implemented in SnapPrefsData, and SnapPrefsDataPersist.

virtual void ISnapPrefsData::SetTIFFTransparent (const bool16 transparent)
pure virtual

Set the TIFF transparency on or off.

Implemented in SnapPrefsData, and SnapPrefsDataPersist.