InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IFrameContentSuite.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: Shengliu Dai
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 // Note:
24 //
25 //========================================================================================
26 
27 #ifndef _IFrameContentSuite_
28 #define _IFrameContentSuite_
29 
30 #include "IReferencePointData.h"
31 
32 //as a return value from GetFittingOptions for the fitting parameter indicating that there is a multiple selection and that
33 //the elements of the selection have differing fitting settings.
34 #define kMixedCropAmount -8641.
35 #define kMixedAutoFit -1
36 
42 class IFrameContentSuite : public IPMUnknown
43  {
44  public:
45  enum { kDefaultIID = IID_IFRAMECONTENTSUITE };
46 
52  typedef enum {
53  kMixedFitting = -1,
54  kNoFitting,
55  kFitContents,
56  kFitProportionally,
57  kFillProportionally
58  } PersistentFitOptions;
59 
60  public:
61 
66  virtual bool16 CanConvertItemToFrame (void) const = 0;
67 
72  virtual bool16 CanSelectConvertItemToFrame (void) const = 0;
77  virtual bool16 CanMultiSelectConvertItemToFrame (void) const = 0;
78 
79 
84  virtual bool16 CanConvertItemToText (void) const = 0;
85 
90  virtual bool16 CanSelectConvertItemToText (void) const = 0;
91 
96  virtual bool16 CanMultiSelectConvertItemToText (void) const = 0;
97 
102  virtual bool16 CanConvertFrameToItem (void) const = 0;
103 
108  virtual bool16 CanSelectConvertFrameToItem (void) const = 0;
109 
114  virtual bool16 CanMultiSelectConvertFrameToItem (void) const = 0;
115 
120  virtual bool16 CanFitFrameToContent (void) const = 0;
121 
126  virtual bool16 CanFitContentToFrame (void) const = 0;
127 
132  virtual bool16 CanFitContentProp (void) const = 0;
133 
138  virtual bool16 CanCenterContentInFrame (void) const = 0;
139 
144  virtual bool16 CanFillFrameProp (void) const = 0;
145 
150  virtual bool16 CanSetFittingOptions (void) const = 0;
151 
156  virtual bool16 CanClearFittingOptions (void) const = 0;
157 
167  virtual bool16 GetFittingOptions(IReferencePointData::ReferencePointPosition *refPoint,
168  PMRect* cropAmounts,
169  PersistentFitOptions *fitting,
170  bool16 *autoFit) const = 0;
171 
176  virtual ErrorCode ConvertItemToFrame (void) = 0;
177 
182  virtual ErrorCode ConvertItemToText (void) = 0;
183 
188  virtual ErrorCode ConvertFrameToItem (void) = 0;
189 
193  virtual ErrorCode FitFrameToContent (void) = 0;
194 
198  virtual ErrorCode FitContentToFrame (void) = 0;
199 
203  virtual ErrorCode FitContentProp (void) = 0;
204 
208  virtual ErrorCode CenterContentInFrame (void) = 0;
209 
213  virtual ErrorCode FillFrameProp (void) = 0;
214 
222  virtual ErrorCode SetFittingOptions(IReferencePointData::ReferencePointPosition refPoint,
223  const PMRect& cropAmounts,
224  PersistentFitOptions fitting /*= kNoFitting*/,
225  bool16 autoFit /*= kFalse*/) = 0;
226 
230  virtual ErrorCode ClearFittingOptions(void) = 0;
231 
236  virtual bool16 CanApplyContentAwareFit(void) const = 0;
237 
241  virtual ErrorCode ApplyContentAwareFit(void) = 0;
242 
247  virtual bool16 CanSearchSimilar(void) const = 0;
248 
252  virtual ErrorCode SearchSimilar(void) = 0;
253  };
254 
255 #endif // _IFrameContentSuite_