InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IPageItemTypeUtils.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 __IPageItemTypeUtils__
25 #define __IPageItemTypeUtils__
26 
27 #include "GenericID.h"
28 #include "IPMUnknown.h"
29 #include "Utils.h"
30 #include "IAnchoredObjectData.h"
31 
32 #include "UIDList.h"
33 
34 class IMainItemTOPData;
35 class IGraphicFrameData;
36 class IHierarchy;
37 class IScrapItem;
38 
39 
40 
46 class IPageItemTypeUtils : public IPMUnknown
47 {
48 public:
49  enum { kDefaultIID = IID_IPAGEITEMTYPEUTILS };
50 
66  virtual void CategorizePageItems (const UIDList, int32 *totalItemCountPtr, int32 *graphicFrameCountPtr, int32 *textFrameCountPtr, int32 *imageCountPtr, int32 *topCountPtr, int32 *guideCountPtr, int32 *standoffCountPtr, int32 *standardItemCountPtr) const = 0;
67 
72  virtual bool16 IsTextOnAPath (const UIDRef& pageItemUIDRef) const = 0;
73 
78  virtual bool16 IsTextOnAPath (const IPMUnknown* iPageItem) const = 0;
79 
84  virtual bool16 IsHTMLPageItem(const UIDRef& pageItemUIDRef) const = 0;
85 
90  virtual bool16 IsHTMLPageItem(const IPMUnknown* iPageItem) const = 0;
91 
96  virtual bool16 IsGraphicFrame (const UIDRef& pageItemUIDRef) const = 0;
97 
102  virtual bool16 IsGraphicFrame (const IPMUnknown* iPageItem) const = 0;
103 
108  virtual bool16 IsTextFrame (const UIDRef& pageItemUIDRef) const = 0;
109 
115  virtual bool16 IsTextFrame (const IPMUnknown* iPageItem) const = 0;
116 
121  virtual bool16 IsGraphic (const UIDRef& pageItemUIDRef) const = 0;
122 
127  virtual bool16 IsGraphic (const IPMUnknown* iPageItem) const = 0;
128 
133  virtual bool16 IsGuide (const UIDRef& pageItemUIDRef) const = 0;
134 
139  virtual bool16 IsGuide (const IPMUnknown* iPageItem) const = 0;
140 
141 
146  virtual bool16 OnlyGuidesInList (const UIDList& items) const = 0;
147 
152  virtual bool16 IsStandOff (const UIDRef& pageItemUIDRef) const = 0;
153 
158  virtual bool16 IsStandOff (const IPMUnknown* iPageItem) const = 0;
159 
164  virtual bool16 HasStandOff (const IPMUnknown*) const = 0;
165 
170  virtual bool16 IsTextInset (const UIDRef& pageItemUIDRef) const = 0;
171 
176  virtual bool16 IsTextInset (const IPMUnknown* iPageItem) const = 0;
177 
182  virtual bool16 HasTextInset (const IPMUnknown*) const = 0;
183 
188  virtual bool16 IsInline (const UIDRef& pageItemUIDRef) const = 0;
189 
194  virtual bool16 IsInline (const IPMUnknown* iPageItem) const = 0;
195 
202  virtual bool16 IsDirectInlineItem (const UIDRef& pageItemUIDRef) const = 0;
203 
210  virtual bool16 IsDirectInlineItem (const IPMUnknown* iPageItem) const = 0;
211 
216  virtual IAnchoredObjectData::AnchoredPosition GetInlinePosition(const UIDRef& pageItemUIDRef) const = 0;
217 
222  virtual IAnchoredObjectData::AnchoredPosition GetInlinePosition(const IPMUnknown* iPageItem) const = 0;
223 
228  virtual bool16 IsGroup (const UIDRef& pageItemUIDRef) const = 0;
229 
234  virtual bool16 IsGroup (const IPMUnknown* iPageItem) const = 0;
235 
240  virtual bool16 IsMedia (const UIDRef& pageItemUIDRef) const = 0;
241 
246  virtual bool16 IsMedia (const IPMUnknown* iPageItem) const = 0;
247 
252  virtual bool16 IsContent (const IPMUnknown* iPageItem) const = 0;
253 
258  virtual bool16 IsContent (const UIDRef& pageItemUIDRef) const = 0;
259 
265  virtual bool16 IsChildOfScrapItem (const IScrapItem*, IScrapItem*) const = 0;
266 
271  virtual bool16 IsInlineInStory(const IPMUnknown* iPageItem) const = 0;
272 
277  virtual bool16 IsInlineInLockedStory(const IPMUnknown* iPageItem) const = 0;
278 
283  virtual bool16 IsWrapSupportedInline(const IPMUnknown* iPageItem) const = 0;
284 
289  virtual bool16 IsPlacedInDesignPage(const IPMUnknown* iPageItem) const = 0;
290 
295  virtual bool16 IsPlacedInDesignPage(const UIDRef& pageItemUIDRef) const = 0;
296 
301  virtual bool16 IsButton(const IPMUnknown* iPageItem) const = 0;
302 
307  virtual bool16 IsButton(const UIDRef& pageItemUIDRef) const = 0;
308 
313  virtual bool16 IsMultiStateObject(const IPMUnknown* iPageItem) const = 0;
314 
319  virtual bool16 IsMultiStateObject(const UIDRef& pageItemUIDRef) const = 0;
320 
325  virtual bool16 IsFormItem( IPMUnknown *inBoss ) const = 0;
326 
331  virtual bool16 IsFormItem( UIDRef inRef ) const = 0;
332 
337  virtual bool16 IsCheckBox(const IPMUnknown* iPageItem) const = 0;
338 
343  virtual bool16 IsCheckBox(const UIDRef& pageItemUIDRef) const = 0;
344 
349  virtual bool16 IsRadioButton(const IPMUnknown* iPageItem) const = 0;
350 
355  virtual bool16 IsRadioButton(const UIDRef& pageItemUIDRef) const = 0;
356 
361  virtual bool16 PageItemHasAppearanceList(const IPMUnknown* iPageItem) const = 0;
362 
367  virtual bool16 PageItemHasAppearanceList(const UIDRef& pageItemUIDRef) const = 0;
368 
373  virtual bool16 IsPlacedInTable(const IPMUnknown* iPageItem) const = 0;
374 
379  virtual bool16 IsPlacedInTable(const UIDRef& pageItemUIDRef) const = 0;
380 
385  virtual bool16 IsDirectlyPlacedInTable(const IPMUnknown* iPageItem) const = 0;
386 
391  virtual bool16 IsDirectlyPlacedInTable(const UIDRef& pageItemUIDRef) const = 0;
392 
397  virtual bool16 IsPlacedInsideText(const IPMUnknown* iPageItem) const = 0;
398 
403  virtual bool16 IsPlacedInsideText(const UIDRef& pageItemUIDRef) const = 0;
404 
409  virtual bool16 IsEndnoteTextFrame(const UIDRef& pageItemUIDRef) const = 0;
410 
416  virtual bool16 IsEndnoteTextFrame(const IPMUnknown* iPageItem) const = 0;
417 
422  virtual bool16 IsEmptyGraphicFrame(const UIDRef& pageItemUIDRef) const = 0;
423 
428  virtual bool16 IsEmptyGraphicFrame(const IPMUnknown* iPageItem) const = 0;
429 
434  virtual bool16 IsNotAFrame(const UIDRef& pageItemUIDRef) const = 0;
435 
440  virtual bool16 IsNotAFrame(const IPMUnknown* iPageItem) const = 0;
441 
446  virtual bool16 IsThreadedTextFrame(const UIDRef& pageItemUIDRef) const = 0;
447 
452  virtual bool16 IsThreadedTextFrame(const IPMUnknown* iPageItem) const = 0;
453 
458  virtual bool16 IsSVGPageItem(const UIDRef& pageItemUIDRef) const = 0;
459 
464  virtual bool16 IsSVGPageItem(const IPMUnknown* iPageItem) const = 0;
465 
470  virtual bool16 IsTableFrame(const UIDRef& pageItemUIDRef) const = 0;
471 
476  virtual bool16 IsTableFrame(const IPMUnknown* iPageItem) const = 0;
477 
482  virtual bool16 IsMathObject(const IPMUnknown* iPageItem) const = 0;
483 
488  virtual bool16 IsMathObject(const UIDRef& pageItemUIDRef) const = 0;
489 };
490 
491 
492 #endif // __IPageItemTypeUtils__