InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IPageItemScrapData.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: Dave Burnard
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 __IPAGEITEMSCRAPDATA__
25 #define __IPAGEITEMSCRAPDATA__
26 
27 #include "IPMUnknown.h"
28 #include "PageItemScrapID.h"
29 
30 //========================================================================================
31 // Forward declarations
32 //========================================================================================
33 
34 class UIDList;
35 class PMPoint;
36 
37 //========================================================================================
38 // CLASS IPageItemScrapData
39 //========================================================================================
40 
52 class IPageItemScrapData : public IPMUnknown
53 {
54 // ----- Constants
55 public:
56  enum { kScrapType = 'PMLY' };
57  enum { kDefaultIID = IID_IPAGEITEMSCRAPDATA };
58 
59 // ----- Constructors/destructors
60 public:
61 
62 // ----- Manipulators
63 public:
71  virtual void Replace(const UIDList& newList) = 0;
72 
78  virtual void Append(UID newItem) = 0;
79 
85  virtual void Append(const UIDList& newList) = 0;
86 
89  virtual void Clear() = 0;
90 
91 // ----- Accessors
92 public:
95  virtual bool16 IsEmpty() const = 0;
96 
102  virtual UIDList* CreateUIDList() const = 0;
103 
106  virtual UIDRef GetRootNode() const = 0;
107 
115  virtual void SetRootNode(const UIDRef& newRoot) = 0;
116 
119  virtual bool16 GetIsGuide() const = 0;
122  virtual void SetIsGuide(bool16 isGuide) = 0;
123 
126  virtual bool16 GetCenterItemOnPaste() const = 0;
129  virtual void SetCenterItemOnPaste(bool16 centerItem) = 0;
130 
133  virtual PMPoint GetPasteInsideOffset(void) const = 0;
134 
144  virtual void SetPasteInsideOffset(const PMPoint& offset) = 0;
145 
148  virtual PMMatrix GetPasteInsideRelativeTransform(void) const = 0;
149 
152  virtual void SetPasteInsideRelativeTransform(const PMMatrix& transform) = 0;
153 };
154 
155 #endif