InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
INoteSuite.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: ???
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 __INoteSuite__
25 #define __INoteSuite__
26 
27 #include "IPMUnknown.h"
28 #include "InCopySharedID.h"
29 #include "ITextSelectionSuite.h"
30 
31 class IControlView;
32 class ISelectionManager;
33 class IDocument;
34 
37 class INoteSuite : public IPMUnknown
38 {
39  public:
40  enum { kDefaultIID = IID_INOTESUITE };
41 
43  enum NavigateType { kNextNote=0, kPreviousNote };
45  enum CopyToNoteType {kWordToNote=0, kLineToNote, kParaToNote, kStoryToNote};
46 
47 
52  virtual bool16 CanAddNote(IControlView* view) const = 0;
53 
58  virtual void DoAddNote(IControlView* view) = 0;
59 
64  virtual bool16 CanConvertToNote(IControlView* view) const = 0;
65 
72  virtual void DoConvertToNote(IControlView* view, ClassID commandBossID) = 0;
73 
82  virtual bool16 CanOpenNote(IControlView* view, IControlView* docView, PMString &menuString) const = 0;
83 
89  virtual void DoOpenNote(IControlView* view, IControlView* docView) = 0;
90 
96  virtual bool16 CanDeleteNote(IControlView* view, IControlView *docView) const = 0;
97 
102  virtual void DoDeleteNote(IControlView* view, IControlView* docView) = 0;
103 
104 
110  virtual bool16 CanConvertToText(IControlView* view, IControlView *docView) const = 0;
111 
116  virtual void DoConvertToText(IControlView* view, IControlView* docView) = 0;
117 
123  virtual bool16 CanScrollToNote(IControlView* view, IControlView *docView) const = 0;
124 
129  virtual void DoScrollToNote(IControlView* view, IControlView* docView) = 0;
130 
131 
138  virtual bool16 CanNavigateNote(IControlView* view, IControlView *docView, bool16 *inPalette=nil) const = 0;
139 
146  virtual void DoNavigateNote(IControlView* view, IControlView* docView, ISelectionManager* selMgr, NavigateType type) = 0;
147 
154  virtual bool16 CanRemoveAllNotes(IControlView* view, IControlView* docView, IDocument *doc) const = 0;
155 
161  virtual void DoRemoveAllNotes(IControlView* view, IControlView* docView, IDocument *doc) = 0;
162 
168  virtual bool16 CanRemoveStoryNotes(IControlView* view, IControlView *docView) const = 0;
169 
174  virtual void DoRemoveStoryNotes(IControlView* view, IControlView* docView) = 0;
175 
183  virtual bool16 CanSplitNote(IControlView* view, IControlView *docView, bool16 bNotesMode = kFalse) const = 0;
184 
189  virtual void DoSplitNote(IControlView* view, IControlView* docView) = 0;
190 
196  virtual bool16 CanShowHideNote(IControlView* view, IControlView *docView) const = 0;
197 
202  virtual void DoShowHideNote(IControlView* view, IControlView* docView) = 0;
203 
204 
210  virtual bool16 CanExpandAllNotes(IControlView* view, IControlView* docView) const = 0;
211 
216  virtual void DoExpandAllNotes(IControlView* view, IControlView* docView) = 0;
217 
218 
224  virtual bool16 CanCollapseAllNotes(IControlView* view, IControlView* docView) const =0;
225 
230  virtual void DoCollapseAllNotes(IControlView* view, IControlView* docView) =0;
231 
232 
237  virtual void SetSelection(IControlView* view, ITextSelectionSuite::Units selectType)=0;
238 
244  virtual void DoSetNoteToPalette(IControlView* view, IControlView* docView) = 0;
245 
250  virtual bool16 IsInNote() const = 0;
251 
252 };
253 
254 #endif // _INoteSuite_