InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
INoteSuiteUtils.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: Cindy Chen
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 __INoteSuiteUtils__
25 #define __INoteSuiteUtils__
26 
27 #include "InCopySharedID.h"
28 
29 //-----------------------------------
30 // Forward References
31 //
32 
33 #include "IPMUnknown.h"
34 #include "UIDRef.h"
35 #include "INoteSuite.h"
36 
37 class ISelectionManager;
38 class IControlView;
39 
43 {
44  public:
45  enum { kDefaultIID = IID_INOTESUITEUTILS };
46 
47 
56  virtual void NavigateNote(ISelectionManager* selMgr, IControlView *docView, TextIndex fromThisTextIndex, UIDRef storyRef, INoteSuite::NavigateType type)=0;
57 
58 
63  virtual bool16 IsLayerEditable(IControlView* layoutView)=0;
64 
65 
70  virtual bool16 IsNoteHidden() =0;
71 
72 
80  virtual bool16 CheckNotesState(UIDRef storyRef, bool16 collapsed)=0;
81 
82 
83 
90  virtual bool16 CanRemoveAllNotes(IDocument* document, UIDRef &storyRef, IControlView *galleyView = nil) =0;
91 
92 
97  virtual bool16 UnlockLayers(UIDList &layerList) = 0;
98 
99 
106  virtual bool16 CheckStoryCollapsed(IControlView *view, ITextModel *textModel = nil) = 0;
107 
108 
114  virtual bool16 CheckExpandedNoteAnchor(IControlView *view, IDocument *doc) = 0;
115 
116 
121  virtual IControlView * GetDocControlView() = 0;
122 
132  virtual bool16 CheckRemoveXML(UIDRef &storyRef, TextIndex start, TextIndex end) = 0;
133 
140  virtual bool16 RemoveAllNotesOnCollapsedStory(IControlView *galleyView, IDocument *doc) = 0;
141 
152  virtual bool16 CheckRemoveRuby(UIDRef &storyRef, TextIndex start, TextIndex end=kInvalidTextIndex) = 0;
153 
154 };
155 
156 #endif // __INoteSuiteUtils__