IClipSettings.h

//========================================================================================
// 
// $File$
// 
// Owner: Dave Stephens
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
// 
// Purpose:
// Data interface for IID_ICLIPSETTINGS used to store and obtain the Clipping Path dialog
// settings used to create a Clipping Path frame using edge detection algorithms.
// 
//========================================================================================

#ifndef __IClipSettings__
#define __IClipSettings__

#include "IPMUnknown.h"
#include "ClippingDlgID.h"

class IClipSettings : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ICLIPSETTINGS };

 typedef enum {
 kClipNone = 0,
 kClipEdgeDetection = 1,
 kClipAlpha = 2,
 kClipEmbeddedPath = 3,
 kClipUserPath = 4 // User-edited path
 } ClipType;

 enum {
 kDefaultClipIndex = -1
 };

 virtual ClipType GetClipType() const = 0;

 virtual PMReal GetTolerance() const = 0;

 virtual PMReal GetInset() const = 0;

 virtual uint8 GetThreshold() const = 0;

 virtual uint8 GetInvert() const = 0;

 virtual uint8 GetUseHighRes() const = 0;

 virtual uint8 GetAllowHoles() const = 0;

 virtual void SetClipType(ClipType clipType) = 0;

 virtual void SetTolerance( PMReal Tolerance) = 0;

 virtual void SetInset( PMReal Inset) = 0;

 virtual void SetThreshold(uint8 Threshold) = 0;

 virtual void SetInvert(bool8 Invert) = 0;

 virtual void SetUseHighRes(bool8 UseHighRes) = 0;

 virtual void SetAllowHoles(bool8 AllowHoles) = 0;
 
 virtual void SetRestrictToFrame( bool8 yesno ) = 0;
 
 virtual bool8 GetRestrictToFrame( void ) const = 0;
 
 
 virtual void SetAlphaIndex( int16 index ) = 0;
 
 virtual int16 GetAlphaIndex( void ) const = 0;

 virtual void SetEmbeddedPathIndex( int16 index ) = 0;
 
 virtual int16 GetEmbeddedPathIndex( void ) const = 0;
};

#endif