InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
INewPageItemCmdData.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: robin briggs
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 // Data interface for creating new page items. The dataBase, classID and type of
25 // default graphic attributes are mandatory settings. The point list and parent
26 // are optional. Note that if the parent is not set a broadcast will not occur
27 // as a result of the new page item command.
28 //
29 //========================================================================================
30 
31 #ifndef __INewPageItemCmdData__
32 #define __INewPageItemCmdData__
33 
34 #include "IPMUnknown.h"
35 #include "UIDRef.h"
36 #include "PMPoint.h"
37 #include "GenericID.h"
38 
39 class IDataBase;
40 
43 class INewPageItemCmdData : public IPMUnknown {
44 public:
45  enum {kDefaultIID = IID_INEWPAGEITEMCMDDATA};
46 
48  enum GraphicAttrType
49  {
51  kNoGraphicAttributes = 0,
53  kDefaultGraphicAttributes,
55  kGraphicFrameAttributes,
57  kTextFrameAttributes,
59  kFrameGridAttributes,
61  kGroupAttributes
62  };
63 
65  enum ObjectStyleApplication
66  {
68  kAlwaysApplyObjectStyle,
70  kNeverApplyObjectStyle,
72  kCommandAppliesObjectStyle
73  };
74 
82  virtual void Set(IDataBase*, const ClassID) = 0;
83  virtual void Set(IDataBase*, const ClassID, const PMPointList& initialPoints) = 0;
84  virtual void Set(IDataBase*, const ClassID, UID parent) = 0;
85  virtual void Set(IDataBase*, const ClassID, UID parent, const PMPointList& initialPoints) = 0;
86 
87  virtual void Set(IDataBase*, const ClassID, GraphicAttrType) = 0;
88  virtual void Set(IDataBase*, const ClassID, GraphicAttrType, const PMPointList& initialPoints) = 0;
89  virtual void Set(IDataBase*, const ClassID, GraphicAttrType, UID parent) = 0;
90  virtual void Set(IDataBase*, const ClassID, GraphicAttrType, UID parent, const PMPointList& initialPoints) = 0;
92 
98  virtual IDataBase* GetDataBase () const = 0;
99  virtual UID GetParent() = 0;
100  virtual ClassID GetItemClass() = 0;
101  virtual const PMPointList& GetPointList() const = 0;
102  virtual GraphicAttrType GetGraphicItemType() const = 0;
104 
107 
111  virtual bool16 AddToHierarchy () const = 0;
112 
116  virtual bool16 HasInitialPointList () const = 0;
117 
121  virtual bool16 HasGraphicAttributes () const = 0;
122 
126  virtual bool16 IsGraphicFrame() const = 0;
127 
131  virtual void SetAllowDefaultStandOff( bool16 bAllowDefaultStandOff ) = 0; // this flag is respected by StandOffNewPIResponder
132 
136  virtual bool16 AllowDefaultStandOff() const = 0; // this flag is respected by StandOffNewPIResponder
138 
144  virtual UID GetInternalPageItem() const = 0;
145  virtual void SetInternalPageItem(UID pgItem) = 0;
147 
151  virtual void SetObjectStyleApplication(ObjectStyleApplication howToApplyObjStyle) = 0;
152  virtual ObjectStyleApplication GetObjectStyleApplication() = 0;
153 };
154 
155 
156 
157 #endif // __INewPageItemCmdData__