InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IStandOff.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: Bernd Paradies
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 
24 #ifndef __IStandOff__
25 #define __IStandOff__
26 
27 #include "IPMUnknown.h"
28 #include "PMRect.h"
29 #include "StandOffID.h" // IsStandOff
30 #include "PMMatrix.h"
31 #include "CTextEnum.h"
32 #include "IParcel.h"
33 #include "ITextFrameColumn.h"
34 #include "ITextParcelList.h"
35 #include "ITextStoryThread.h"
36 
37 class IGeometry;
38 class ITransform;
39 
40 
41 //---------------------------------------------------------------
42 // class IStandOff
43 //---------------------------------------------------------------
44 
50 class IStandOff : public IPMUnknown
51 {
52 public:
56  enum { kDefaultIID = IID_ISTANDOFF };
57 
61  enum mode
62  {
64  kNone = 0,
65 
67  kBand = 1,
68 
70  kNextFrame = 2,
71 
73  kBoundingBox = 3,
74 
75 #ifdef ID_DEPRECATED
76  kBothSides = kBoundingBox,
77 
79  kWithinHoles = 4, // Invalid, unimplemented
80 
82  kAutoContour = 5, // Invalid, unimplemented
83 #endif
84 
85  kManualContour = 6,
86 
87 #ifdef ID_DEPRECATED
88 
89  kLeftContour = 7, // Invalid, unimplemented
90 
92  kRightContour = 8, // Invalid, unimplemented
93 
94 #endif
95 
96  kDefaultMode = kNone
97  };
98 
102  enum form
103  {
105  kRegular,
106 
108  kInvert,
109 
111  kDefaultForm = kRegular
112  };
113 
117  enum side
118  {
120  kBoth,
121 
123  kLeft,
124 
126  kRight,
127 
129  kToBinding,
130 
132  kAwayBinding,
133 
135  kLargest,
136 
138  kDefaultSide = kBoth
139 
140  };
141 
145  virtual void GetBounds( PBPMRect *pRect ) const = 0;
146 
150  virtual IGeometry *QueryStandOffGeometry() const = 0;
151 
155  virtual bool16 UpdateStandOffGeometry() = 0;
156 
160  virtual IGeometry *DeleteStandOff() = 0;
161 
168  virtual void IgnoreUpdateStandOffGeometryCalls(bool bIgnore) = 0;
169 };
170 
171 DECLARE_BASE_TYPE(IStandOff::form);
172 DECLARE_BASE_TYPE(IStandOff::mode);
173 DECLARE_BASE_TYPE(IStandOff::side);
174 
175 #endif
176  // __IStandOff__
177