InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IItemsToPlaceData.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: vaggarwa
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 __IItemsToPlaceData__
25 #define __IItemsToPlaceData__
26 
27 // ----- Includes -----
28 
29 // ----- ID.h files -----
30 #include "LayoutUIID.h"
31 
32 
33 //========================================================================================
34 // class IItemsToPlaceData
35 //========================================================================================
36 
37 class IItemsToPlaceData : public IPMUnknown
38 {
39 public:
40  enum { kDefaultIID = IID_IITEMSTOPLACEDATA };
41 
43  enum ePlaceFrom {
45  kPlaceGun,
47  kPlaceHead,
48  };
49 
50  //Gets the first Item uid to be placed.
51  virtual UID GetFirstItemUID(IDocument* document) const = 0;
52 
53  //Finds if there are still items to be placed
54  virtual bool16 IsLoaded(IDocument* document) const = 0;
55 
56  //Returns number of items to be placed
57  virtual int32 CountItemsToPlace(IDocument* document) const = 0;
58 
59  //Clears the queue of items to be placed
60  virtual ErrorCode ClearFirstItem(IDocument* document) = 0;
61 
62  virtual ErrorCode ClearQueue(IDocument* document) = 0;
63 
64  //Aborts the place action
65  virtual ErrorCode AbortFirstItem(IDocument* document) = 0;
66 
67  virtual ErrorCode AbortPlace(IDocument* document) = 0;
68 
69  //returns the place whether the items to be placed are to be taken from PlaceGun or PlaceHead
70  virtual IItemsToPlaceData::ePlaceFrom GetPlaceSource() = 0;
71 
72 };
73 
74 
75 
76 
77 #endif