InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IAnchoredObjectSuite.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner:
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 _IAnchoredObjectSuite_
28 #define _IAnchoredObjectSuite_
29 
30 #include "IPMUnknown.h"
31 
32 #include "IAnchoredObjectData.h" // for enums
33 #include "IAnchoredObjectInsertData.h" // for enums
34 
40 class IAnchoredObjectSuite : public IPMUnknown
41 {
42 public:
43  enum { kDefaultIID = IID_IANCHOREDOBJECT_ISUITE };
44 
48  virtual bool16 CanSetAnchoredObjectParams() const = 0;
52  virtual bool16 CanSetAnchoredObjectInsertParams() const = 0;
53 
57  virtual bool16 CanInsertAnchoredObject() const = 0;
64  virtual ErrorCode InsertAnchoredObject(IAnchoredObjectInsertData *objectSpec, bool16 toggleSelection = kFalse) = 0;
65 
69  virtual bool16 CanToggleBetweenAnchoredFrame() const = 0;
70 
82  virtual ErrorCode ToggleBetweenAnchoredFrame(UIDRef& toggledFrame, TextIndex& location) const = 0;
83 
87  virtual bool16 CanReleaseAnchoredObject() const = 0;
92  virtual ErrorCode ReleaseAnchoredObject() = 0;
93 
97  virtual bool16 CanSetAnchoredPosition() const = 0;
102  virtual ErrorCode SetPosition(IAnchoredObjectData::AnchoredPosition position) = 0;
107  virtual IAnchoredObjectData::AnchoredPosition GetPosition(bool16 *mixed = nil) const = 0;
108 
112  virtual bool16 CanGetSpineRelative() const = 0;
117  virtual ErrorCode SetSpineRelative(bool16 splineRelative) = 0;
122  virtual bool16 GetSpineRelative(bool16 *mixed = nil) const = 0;
123 
128  virtual ErrorCode SetAnchorTypeHorizontal(IAnchoredObjectData::HorizontalAnchorPointObject location) = 0;
133  virtual IAnchoredObjectData::HorizontalAnchorPointObject GetAnchorTypeHorizontal(bool16 *mixed = nil) const = 0;
134 
139  virtual ErrorCode SetObjectHorizontal(IAnchoredObjectData::AnchoredHorizontal align) = 0;
144  virtual IAnchoredObjectData::AnchoredHorizontal GetObjectHorizontal(bool16 *mixed = nil) const = 0;
145 
150  virtual ErrorCode SetAnchorPtHorizontal(IAnchoredObjectData::AnchoredHorizontal align) = 0;
155  virtual IAnchoredObjectData::AnchoredHorizontal GetAnchorPtHorizontal(bool16 *mixed = nil) const = 0;
156 
161  virtual ErrorCode SetAnchorTypeVertical(IAnchoredObjectData::VerticalAnchorPointObject location) = 0;
166  virtual IAnchoredObjectData::VerticalAnchorPointObject GetAnchorTypeVertical(bool16 *mixed = nil) const = 0;
167 
172  virtual ErrorCode SetObjectVertical(IAnchoredObjectData::AnchoredVertical align) = 0;
177  virtual IAnchoredObjectData::AnchoredVertical GetObjectVertical(bool16 *mixed = nil) const = 0;
178 
183  virtual ErrorCode SetAnchorPtVertical(IAnchoredObjectData::AnchoredVertical align) = 0;
188  virtual IAnchoredObjectData::AnchoredVertical GetAnchorPtVertical(bool16 *mixed = nil) const = 0;
189 
197  virtual ErrorCode SetXOffset(PMReal xoffset) = 0;
202  virtual ErrorCode SetYOffset(PMReal yoffset) = 0;
207  virtual PMPoint GetOffset(bool16 *mixed = nil) const = 0;
208 
214  virtual ErrorCode SetYOffsetAbove(PMReal yoffset) = 0;
220  virtual PMReal GetYOffsetAbove(bool16 *mixed = nil) const = 0;
221 
226  virtual ErrorCode SetPinPosition(bool16 pinPos) = 0;
231  virtual bool16 GetPinPosition(bool16 *mixed = nil) const = 0;
232 
238  virtual ErrorCode SetLockPosition(bool16 lock) = 0;
244  virtual bool16 GetLockPosition(bool16 *mixed = nil) const = 0;
245 
250  virtual ErrorCode SetInitialContent(IAnchoredObjectInsertData::AnchoredContent content) = 0;
254  virtual IAnchoredObjectInsertData::AnchoredContent GetInitialContent() const = 0;
255 
260  virtual ErrorCode SetInitialObjectStyle(UID styleID) = 0;
264  virtual UID GetInitialObjectStyle() const = 0;
265 
270  virtual ErrorCode SetInitialParagraphStyle(UID styleID) = 0;
274  virtual UID GetInitialParagraphStyle() const = 0;
275 
280  virtual ErrorCode SetInitialWidth(PMReal w) = 0;
284  virtual PMReal GetInitialWidth() const = 0;
285 
290  virtual ErrorCode SetInitialHeight(PMReal h) = 0;
294  virtual PMReal GetInitialHeight() const = 0;
295 
299  virtual PMReal GetSmallestObjectHeight() const = 0;
300 
304  virtual PMReal GetSmallestLineHeight() const = 0;
305 
309  virtual bool16 ObjectInVerticalText() const = 0;
310 
311 };
312 
313 #endif // _IAnchoredObjectSuite_