InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
SnapPrefsData Class Reference
Inheritance diagram for SnapPrefsData:
CPMUnknown< ISnapPrefsData >ISnapPrefsDataIPMUnknown

Public Member Functions

 SnapPrefsData (IPMUnknown *boss)
 
virtual void CopyPrefs (ISnapPrefsData *prefsToCopy)
 
virtual void SetName (const WideString &name)
 
virtual const WideStringGetName ()
 
virtual void SetFormatClassID (const ClassID &formatClassID)
 
virtual const ClassIDGetFormatClassID ()
 
virtual void SetScale (const PMReal &scale)
 
virtual const PMRealGetScale ()
 
virtual void SetResolution (const PMReal &resolution)
 
virtual const PMRealGetResolution ()
 
virtual void SetMinimumResolution (const PMReal &minimumResolution)
 
virtual const PMRealGetMinimumResolution ()
 
virtual void SetBleed (const PMReal &bleed)
 
virtual const PMRealGetBleed ()
 
virtual void SetDrawArea (bool16 drawArea)
 
virtual const bool16 & GetDrawArea ()
 
virtual void SetFullResolutionGraphics (bool16 fullResolutionGraphics)
 
virtual const bool16 & GetFullResolutionGraphics ()
 
virtual void SetDrawGray (bool16 drawGray)
 
virtual const bool16 & GetDrawGray ()
 
virtual void SetDrawingFlags (int32 drawingFlags)
 
virtual const int32 & GetDrawingFlags ()
 
virtual void SetJPEGEncoding (const int32 encoding)
 
virtual const int32 & GetJPEGEncoding ()
 
virtual void SetJPEGQuality (const int32 quality)
 
virtual const int32 & GetJPEGQuality ()
 
virtual void SetTIFFPaletteType (const int32 paletteType)
 
virtual const int32 & GetTIFFPaletteType ()
 
virtual void SetGIFPaletteType (const int32 paletteType)
 
virtual const int32 & GetGIFPaletteType ()
 
virtual void SetTIFFTransparent (const bool16 transparent)
 
virtual const bool16 & GetTIFFTransparent ()
 
virtual void SetGIFTransparent (const bool16 transparent)
 
virtual const bool16 & GetGIFTransparent ()
 
virtual void SetGIFInterlaced (const bool16 interlaced)
 
virtual const bool16 & GetGIFInterlaced ()
 
- Public Member Functions inherited from CPMUnknown< ISnapPrefsData >
IPMUnknownQueryInterface (PMIID interfaceID) const
 
void AddRef () const
 
void Release () const
 
void PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
void PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
 CPMUnknown (const CPMUnknown &)=delete
 
CPMUnknownoperator= (const CPMUnknown &)=delete
 

Additional Inherited Members

- Public Types inherited from ISnapPrefsData
enum  { kDefaultIID = IID_ISNAPPREFSDATA }
 
- Protected Member Functions inherited from CPMUnknown< ISnapPrefsData >
 CPMUnknown (IPMUnknown *boss)
 
- Protected Attributes inherited from CPMUnknown< ISnapPrefsData >
HelperInterface fHelperInterface
 

Detailed Description

SnapPrefsData

The non-persistent implementation of ISnapPrefsData.

Member Function Documentation

void SnapPrefsData::CopyPrefs (ISnapPrefsDataprefsToCopy)
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

Implements ISnapPrefsData.

const PMReal & SnapPrefsData::GetBleed ()
virtual

Get the bleed.

Implements ISnapPrefsData.

const bool16 & SnapPrefsData::GetDrawArea ()
virtual

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

Implements ISnapPrefsData.

const bool16 & SnapPrefsData::GetDrawGray ()
virtual

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

Implements ISnapPrefsData.

const int32 & SnapPrefsData::GetDrawingFlags ()
virtual

Get the drawing flag.

Implements ISnapPrefsData.

const ClassID & SnapPrefsData::GetFormatClassID ()
virtual

Get the image write format class ID.

Implements ISnapPrefsData.

const bool16 & SnapPrefsData::GetFullResolutionGraphics ()
virtual

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

Implements ISnapPrefsData.

const bool16 & SnapPrefsData::GetGIFInterlaced ()
virtual

Get the interlace flag for GIF image.

Implements ISnapPrefsData.

const int32 & SnapPrefsData::GetGIFPaletteType ()
virtual

Get the palette type for GIF image.

Implements ISnapPrefsData.

const bool16 & SnapPrefsData::GetGIFTransparent ()
virtual

Get the transparency flag for GIF image.

Implements ISnapPrefsData.

const int32 & SnapPrefsData::GetJPEGEncoding ()
virtual

Get the JPEG encoding.

Implements ISnapPrefsData.

const int32 & SnapPrefsData::GetJPEGQuality ()
virtual

Get JPEG quality.

Implements ISnapPrefsData.

const PMReal & SnapPrefsData::GetMinimumResolution ()
virtual

Get the minimum image resolution.

Implements ISnapPrefsData.

const WideString & SnapPrefsData::GetName ()
virtual

Get the file name.

Implements ISnapPrefsData.

const PMReal & SnapPrefsData::GetResolution ()
virtual

Get the image resolution.

Implements ISnapPrefsData.

const PMReal & SnapPrefsData::GetScale ()
virtual

Get the x and y scale factor.

Implements ISnapPrefsData.

const int32 & SnapPrefsData::GetTIFFPaletteType ()
virtual

Get the palette type for TIFF image.

Implements ISnapPrefsData.

const bool16 & SnapPrefsData::GetTIFFTransparent ()
virtual

Get the transparency flag for TIFF image.

Implements ISnapPrefsData.

void SnapPrefsData::SetBleed (const PMRealbleed)
virtual

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

Implements ISnapPrefsData.

void SnapPrefsData::SetDrawArea (bool16 drawArea)
virtual

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

Implements ISnapPrefsData.

void SnapPrefsData::SetDrawGray (bool16 drawGray)
virtual

Set to kTrue to draw grayscale, otherwise draw RGB.

Implements ISnapPrefsData.

void SnapPrefsData::SetDrawingFlags (int32 drawingFlags)
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

Implements ISnapPrefsData.

void SnapPrefsData::SetFormatClassID (const ClassIDformatClassID)
virtual

Set the image write format class ID.

Implements ISnapPrefsData.

void SnapPrefsData::SetFullResolutionGraphics (bool16 fullResolutionGraphics)
virtual

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

Implements ISnapPrefsData.

void SnapPrefsData::SetGIFInterlaced (const bool16 interlaced)
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.

Implements ISnapPrefsData.

void SnapPrefsData::SetGIFPaletteType (const int32 paletteType)
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.

Implements ISnapPrefsData.

void SnapPrefsData::SetGIFTransparent (const bool16 transparent)
virtual

Set the transparency flag for GIF image.

Implements ISnapPrefsData.

void SnapPrefsData::SetJPEGEncoding (const int32 encoding)
virtual

Set the JPEG encoding

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

Implements ISnapPrefsData.

void SnapPrefsData::SetJPEGQuality (const int32 quality)
virtual

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

Implements ISnapPrefsData.

void SnapPrefsData::SetMinimumResolution (const PMRealminimumResolution)
virtual

Set the minimum image resolution.

Implements ISnapPrefsData.

void SnapPrefsData::SetName (const WideStringname)
virtual

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

Implements ISnapPrefsData.

void SnapPrefsData::SetResolution (const PMRealresolution)
virtual

Set the image resolution.

Implements ISnapPrefsData.

void SnapPrefsData::SetScale (const PMRealscale)
virtual

Set the x and y scale factor.

Implements ISnapPrefsData.

void SnapPrefsData::SetTIFFPaletteType (const int32 paletteType)
virtual

Set the palette type for TIFF image.

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

Implements ISnapPrefsData.

void SnapPrefsData::SetTIFFTransparent (const bool16 transparent)
virtual

Set the TIFF transparency on or off.

Implements ISnapPrefsData.