InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IInsertIndexMarkCmdData.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: Michel Hutinel
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 __IInsertIndexMarkCmdData__
25 #define __IInsertIndexMarkCmdData__
26 
27 #include "IPMUnknown.h"
28 #include "IndexingID.h"
29 #include "UIDRef.h"
30 #include "ITextModel.h"
31 #include "K2Pair.h"
32 #include "K2Vector.h"
33 
34 typedef K2Pair<UIDRef, TextIndex> PageEntryInfo;
35 typedef K2Vector<PageEntryInfo> PageEntryInfoArray;
36 
47 class IInsertIndexMarkCmdData : public IPMUnknown
48 {
49  public:
50  enum { kDefaultIID = IID_IINSERTINDEXMARKCMDDATA };
51 
55  virtual const UIDRef& GetPageEntryUIDRef() const = 0;
56 
65  virtual void SetPageEntryUIDRef(const UIDRef& pageEntryUIDRef) = 0;
66 
70  virtual PageEntryInfoArray const& GetPageEntriesInfo() const = 0;
71 
76  virtual void SetPageEntriesInfo(PageEntryInfoArray const& pageEntries) = 0;
77 
81  virtual const UIDRef& GetTargetItem() const = 0;
82 
86  virtual void SetTargetItem(const UIDRef& targetItem) = 0;
87 
91  virtual void SkipInsertingMarkerCharacter() = 0;
92 
96  virtual bool16 ShouldSkipInsertingMarkerCharacter() const = 0;
97 };
98 
99 #endif // __IInsertIndexMarkCmdData__