InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ISetClipValuesCmdData.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: Dave Stephens
6 //
7 // $Author$
8 //
9 // $DateTime$
10 //
11 // $Revision$
12 //
13 // $Change$
14 //
15 // Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
16 //
17 // NOTICE: Adobe permits you to use, modify, and distribute this file in accordance
18 // with the terms of the Adobe license agreement accompanying it. If you have received
19 // this file from a source other than Adobe, then your use, modification, or
20 // distribution of it requires the prior written permission of Adobe.
21 //
22 //
23 // Purpose:
24 // Command data interface for the ISetClipValuesCmd. This command is used to save off
25 // the clipping path settings used to create a Clipping Path frame using edge detection
26 // algorithms.
27 //
28 //========================================================================================
29 
30 #ifndef __ISetClipValuesCmdData__
31 #define __ISetClipValuesCmdData__
32 
33 #include "IPMUnknown.h"
34 #include "IClipSettings.h"
35 
43 {
44 public:
52  virtual void SetImageItem(IDataBase *db, UID id) = 0;
53 
61  virtual void SetDocument(UIDRef& document) = 0;
62 
85  virtual void Set(IClipSettings::ClipType clipType,
86  int16 index,
87  PMReal Tolerance,
88  PMReal Inset,
89  uint8 Threshold,
90  bool8 Invert,
91  bool8 UseHighRes,
92  bool8 AllowHoles,
93  bool8 restrict) = 0;
94 
99  virtual IDataBase* GetDataBase() const = 0;
100 
105  virtual UID GetImageUID() const = 0;
106 
111  virtual const UIDRef& GetDocument() const = 0;
112 
117  virtual IClipSettings::ClipType GetClipType() const = 0;
118 
123  virtual PMReal GetTolerance() const = 0;
124 
129  virtual PMReal GetInset() const = 0;
130 
135  virtual uint8 GetThreshold() const = 0;
136 
141  virtual bool8 GetInvert() const = 0;
142 
147  virtual bool8 GetUseHighRes() const = 0;
148 
153  virtual bool8 GetAllowHoles() const = 0;
154 
159  virtual bool8 GetRestrictToFrame() const = 0;
160 
165  virtual int16 GetIndex() const = 0;
166 };
167 
168 #endif // __ISetClipValuesCmdData__