InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IPlaceGun.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: zwilliam
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 __IPlaceGun__
25 #define __IPlaceGun__
26 
27 #include "IPMUnknown.h"
28 #include "OpenPlaceID.h"
29 
30 class ITracker;
31 
35 class IPlaceGun : public IPMUnknown
36 {
37 public:
38  enum { kDefaultIID = IID_IPLACEGUN };
39 
43  virtual bool16 IsLoaded() const = 0;
44 
48  virtual uint32 CountPlaceGunUIDs() const= 0;
49 
53  typedef enum {
55  kAddToFront,
57  kAddToBack
58  } PlaceGunLocation;
59 
66  virtual void LoadPlaceGun(UID uid, PlaceGunLocation where = kAddToBack) = 0;
67 
71  virtual void EmptyFirstPlaceGunItem() = 0;
72 
76  virtual UID GetFirstPlaceGunItemUID() const = 0;
77 
81  virtual UID GetNthPlaceGunItemUID( uint32 n ) const = 0;
82 
88  virtual UID GetAbortingItemUID() const = 0;
89 
93  virtual void SetAbortingItemUID(UID uid) = 0;
94 
99  virtual bool16 ContainsUID(UID uid) = 0;
100 
105  virtual bool16 OwnsAnyPageItemsOnLayer(UID spreadLayerUID) const = 0;
106 
111  virtual bool16 OwnsAnyPageItemsOnSpread(UID spreadUID) const = 0;
112 
116  virtual void RotateList(bool16 forward) = 0;
117 
118 };
119 
120 #endif